All Products
Search
Document Center

ENS:DescribeServcieSchedule

Last Updated:Mar 12, 2024

You can call the DescribeServcieSchedule to query the real-time status of the instance device or container that is being occupied by the UUID.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
AppIdstringYes

The ID of the application.

474bdef0-d149-4695-abfb-52912d9143f0
UuidstringYes

The UUID of the device.

hdm_f022bf160dc69e2d8eb421e508eb9170
PodConfigNamestringNo

This parameter does not take effect.

android

Response parameters

ParameterTypeDescriptionExample
object
Indexinteger

The index number of the scheduled virtual device (pod).

2
InstanceIdstring

The ID of the scheduled instance.

i-5myukg7hnpbto7m024002w8qd
InstanceIpstring

The IP address of the scheduled instance.

120.26.79.96
InstancePortinteger

The start port of the scheduled instance.

3306
PodAbstractInfoobject

The summary information about the scheduled virtual device.

ContainerServiceboolean

The name of the container service.

android
ContainerStatusesobject []

The information about the container.

ContainerIdstring

The ID of the container.

container_e79_1638372147094_158091_02_000001
Namestring

The name of the container.

nginx
Nameboolean

The name of the pod.

gcs-prod-websocket-eip-telecom
Namespaceboolean

The name of the namespace.

default-aliyun
ResourceScopeboolean

The pod scope.

FDN
Statusboolean

The status of the pod.

RUNNING
RequestIdstring

The ID of the request.

CEF72CEB-54B6-4AE8-B225-F876FF7BA984
RequestRepeatedboolean

Indicates whether the request is repeated.

false
TcpPortsstring

The TCP port range of the scheduled instance or container. The value is in the ${from}-$-{to} format. Example: 80-88.

80-88

Examples

Sample success responses

JSONformat

{
  "Index": 2,
  "InstanceId": "i-5myukg7hnpbto7m024002w8qd",
  "InstanceIp": "120.26.79.96",
  "InstancePort": 3306,
  "PodAbstractInfo": {
    "ContainerService": true,
    "ContainerStatuses": {
      "ContainerStatus": [
        {
          "ContainerId": "container_e79_1638372147094_158091_02_000001",
          "Name": "nginx"
        }
      ]
    },
    "Name": true,
    "Namespace": true,
    "ResourceScope": true,
    "Status": true
  },
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "RequestRepeated": false,
  "TcpPorts": "80-88"
}

Error codes

HTTP status codeError codeError messageDescription
400MissingParameterThe input parameter that is mandatory for processing this request is not supplied.-
400NoPermissionPermission denied.-
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-
400InvalidParameterThe errorMessage is %s. Please check it again.-
400LimitExceeded.SecurityGroupThe number of securityGroup exceeds the limit.-
400ens.interface.errorAn error occurred while calling the API.-
400CallInterfaceCall Interface Happen Error.An error occurred when you call the operation.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-12-26API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    Error Codes 400 change