Retrieves the staging environment deployment status of an application by application ID.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| AppId |
string |
No |
The application ID. You can call ListEdgeContainerApps to obtain the application ID. Important AppId is required. If AppId is not specified, the API returns InvalidParameter.appid (400). You can call ListEdgeContainerApps to obtain the application ID.
The AppId format is the prefix app- followed by 18 or more digits (at least 20 characters in total). You can obtain the actual value from the AppId field in the ListEdgeContainerApps response.
Complete call chain example: CreateEdgeContainerApp → Call ListEdgeContainerApps to obtain AppId → GetEdgeContainerStagingDeployStatus |
GetEdgeContainerStagingDeployStatus |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| Phase |
string |
The status of the container in the staging environment. Valid values:
|
Running |
| CreationTimestamp |
string |
The creation time (UNIX timestamp). |
2024-09-24T06:46:35Z |
| Initialized |
string |
The container initialization status. Valid values:
|
ok |
| Scheduled |
string |
The container scheduling status. Valid values:
|
ok |
| Ready |
string |
Indicates whether the container is ready to receive traffic. Valid values:
|
ok |
| ContainersReady |
string |
Indicates whether the container status is ready. Valid values:
|
ok |
| PodRestartState |
object |
The container restart status. |
|
| RestartCount |
integer |
The number of restarts. |
1 |
| LastTerminatedReason |
string |
The reason for the last restart. |
OOMKilled |
| RequestId |
string |
The request ID. |
2F2C992B-3FE2-5EBB-A61F-F9DD4EB257DA |
| VIPs |
array |
The list of VIPs. |
|
|
string |
VIP |
1.1.1.1 |
Examples
Success response
JSON format
{
"Phase": "Running",
"CreationTimestamp": "2024-09-24T06:46:35Z",
"Initialized": "ok",
"Scheduled": "ok",
"Ready": "ok",
"ContainersReady": "ok",
"PodRestartState": {
"RestartCount": 1,
"LastTerminatedReason": "OOMKilled"
},
"RequestId": "2F2C992B-3FE2-5EBB-A61F-F9DD4EB257DA",
"VIPs": [
"1.1.1.1"
]
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParameter.appid | The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID. | The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID. |
| 400 | InvalidParameter | The specified parameter is invalid. | The specified parameter is invalid. |
| 500 | InternalError | Failed to call the service. Try again later or contact technical support. | Failed to call the service. Try again later or contact technical support. |
| 404 | InvalidApp.NotFound | The application does not exist. Check whether the application ID you specified is correct and try again. | The application does not exist. Check whether the application ID you specified is correct and try again. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.