Querying the Creation Progress of a Dedicated Gateway
Function
This API is used to query the creation progress of a dedicated gateway.
URI
GET /v2/{project_id}/apigw/instances/{instance_id}/progress
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
project_id |
Yes |
String |
Project ID. For details about how to obtain a project ID, see "Appendix" > "Obtaining a Project ID" in this document. |
instance_id |
Yes |
String |
Gateway ID. |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token. |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
progress |
Integer |
Gateway creation progress. Unit: % Enumeration values:
|
status |
String |
Gateway creation status.
Enumeration values:
|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
start_time |
Long |
Time when the gateway creation starts. The time is in the Unix timestamp format. |
end_time |
Long |
Time when the gateway creation is completed. The time is in the Unix timestamp format. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Example Requests
None
Example Responses
Status code: 200
OK
{ "end_time" : 1597390224911, "error_code" : null, "error_msg" : null, "progress" : 100, "start_time" : 1597389901161, "status" : "success" }
Status code: 401
Unauthorized
{ "error_code" : "APIC.7102", "error_msg" : "Incorrect token or token resolution failed" }
Status code: 403
Forbidden
{ "error_code" : "APIC.7106", "error_msg" : "No permissions to request for the method" }
Status code: 404
Not Found
{ "error_code" : "APIC.7302", "error_msg" : "Instance not found" }
Status code: 500
Internal Server Error
{ "error_code" : "APIC.9000", "error_msg" : "Failed to request internal service" }
Status Codes
Status Code |
Description |
---|---|
200 |
OK |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
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