Querying Asynchronous Operation Results
Function
Querying Asynchronous Operation Results
URI
GET /v2/{project_id}/operation/record
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID obtained from IAM. Generally, a project ID contains 32 characters. |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
blockchain_id |
No |
String |
Blockchain ID. |
operation_status |
No |
String |
Operation status. Options (Information in the brackets describes the status.): waiting (to be processed), processing, finished (successful), failed, and stop (interrupted). Enumeration values:
|
resource_type |
No |
String |
Resource type. Options (Information in the brackets describes the type): BCSSVC01 (BCS), BCSSVC02 (UGBaaS), PLUGIN01 (RESTful API add-on), PLUGIN02 (trusted computing add-on), and PLUGIN03 (light-node add-on). Enumeration values:
|
operation_type |
No |
String |
Operation type. Options (Information in the brackets describes the type.): 99 (OpCreate), 00 (OpDelete), 01 (OpUpgrade), 91 (OpUpgradeRb), 02 (OpAddOrg), 03 (OpScaleOrg), 04 (OpJoinChannel), and 05 (OpJoinUnion). Enumeration values:
|
operation_id |
No |
String |
Operation record ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token obtained from IAM. Minimum: 1 Maximum: 32768 |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
count |
Long |
Total number of operation records. |
operation_records |
Array of RecordDetailInfo objects |
Operation records. |
Parameter |
Type |
Description |
---|---|---|
operation_id |
String |
Operation record ID. |
resource_type |
String |
Resource type. |
operation_type |
String |
Operation type. |
domain_id |
String |
Tenant ID. |
project_id |
String |
Project ID. |
blockchain_id |
String |
Blockchain ID. |
blockchain_name |
String |
Blockchain name. |
cluster_info |
OprecordCluster object |
Cluster information. |
operation_process |
Map<String,ProcessInfo> |
Operation process. The key is the process name and the value is the process information. |
record_time |
Long |
Time when the record was last modified. |
operation_status |
String |
Operation status. |
message |
Array of strings |
Operation process information. |
desc |
String |
Operation description. |
Parameter |
Type |
Description |
---|---|---|
cluster_type |
String |
Cluster type. |
name |
String |
Cluster name. |
cluster_id |
String |
Cluster ID. |
node_infos |
Array of NodeInfo objects |
Node information. |
Parameter |
Type |
Description |
---|---|---|
step_name |
String |
Operation name. |
status |
String |
Operation status. |
detail |
String |
Operation details. |
sub_steps |
Map<String,SubDetail> |
Sub-operation information in the format of "map[string][SubDetail]". The key is the sub-operation name and the value is the sub-operation result. |
serial_num |
Long |
Serial number. |
Parameter |
Type |
Description |
---|---|---|
substep_name |
String |
Sub-operation name. |
detail |
String |
Sub-operation details. |
status |
String |
Sub-operation status. |
message |
Array of strings |
Sub-operation process information. |
start_time |
Long |
Start time. |
end_time |
Long |
End time. |
serial_num |
Long |
Serial number. |
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message. Minimum: 2 Maximum: 512 |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message. Minimum: 2 Maximum: 512 |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message. Minimum: 2 Maximum: 512 |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message. Minimum: 2 Maximum: 512 |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. Minimum: 8 Maximum: 36 |
error_msg |
String |
Error message. Minimum: 2 Maximum: 512 |
Example Requests
None
Example Responses
Status code: 200
Ok
{ "count" : 1, "operation_records" : [ { "operation_id" : "BCSSVC01-99-1618218591906093855", "resource_type" : "BCSSVC01", "operation_type" : "99", "domain_id" : "051ddda36880d3420f9bc01403fd8da0", "project_id" : "051ddda57400d2982fccc014fab5749d", "blockchain_id" : "23604f57-eac9-3777-e9f5-ae87457f2338", "blockchain_name" : "bcs-i3b0ms", "cluster_info" : { "cluster_type" : "cce", "name" : "asdfasf", "cluster_id" : "4df5652f-96dc-11eb-b49c-0255ac100b08", "node_infos" : null }, "operation_process" : { "Create Other Dependent Resource" : { "step_name" : "Create Other Dependent Resource", "status" : "processing", "detail" : "", "sub_steps" : { "Create EIP" : { "substep_name" : "Create EIP", "detail" : null, "status" : "finished", "message" : null, "start_time" : 1618219038464462600, "end_time" : 1618219038464462600, "serial_num" : 1 }, "Create network storage" : { "substep_name" : "Create network storage", "detail" : "waiting", "status" : "", "message" : null, "start_time" : 0, "end_time" : 0, "serial_num" : 2 } }, "serial_num" : 2 }, "Preparation" : { "step_name" : "Preparation", "status" : "finished", "detail" : "", "sub_steps" : { "Generate basic configurations" : { "substep_name" : "Generate basic configurations", "detail" : null, "status" : "finished", "message" : null, "start_time" : 1618218591951266000, "end_time" : 1618218591951266000, "serial_num" : 3 } }, "serial_num" : 1 } }, "record_time" : 1618218591906100000, "operation_status" : "processing", "message" : null, "desc" : null } ] }
Status code: 400
Bad Request
{ "error_code" : "BCS.4006005", "error_msg" : "keyType error, keyType: blok not supported" }
Status code: 401
Unauthorized
{ "error_code" : "BCS.4010401", "error_msg" : "Incorrect token or token resolution failed" }
Status code: 403
Forbidden
{ "error_code" : "BCS.4030403", "error_msg" : "No permissions to request this method" }
Status code: 404
Not Found
{ "error_code" : "BCS.4040404", "error_msg" : "Not Found:the url is not found" }
Status code: 500
InternalServerError
{ "error_code" : "BCS.5000500", "error_msg" : "Internal Server Error" }
Status Codes
Status Code |
Description |
---|---|
200 |
Ok |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
InternalServerError |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot