DescribeServcieSchedule - ENS - Alibaba Cloud Documentation Center

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ens:DescribeServcieSchedule		All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the application.	474bdef0-d149-4695-abfb-52912d91****
Uuid	string	Yes	The unique ID of the device.	hdm_f022bf160dc69e2d8eb421e508eb****
PodConfigName	string	No	This parameter does not take effect.	android

Response parameters

Parameter	Type	Description	Example
	object
Index	integer	The index number of the scheduled virtual device (pod).	2
InstanceId	string	The ID of the scheduled instance.	i-5myukg7hnpbto7m024002****
InstanceIp	string	The ID of the scheduled instance.	120.26.XX.XX
InstancePort	integer	The start port of the scheduled instance.	3306
PodAbstractInfo	object	The summary information about the scheduled virtual device.
ContainerService	boolean	The name of the container service.	android
ContainerStatuses	array<object>	The information about the container.
ContainerStatus	object
ContainerId	string	The ID of the container.	container_e79_1638372147094_158091_02_000001
Name	string	The name of the container.	nginx
Name	boolean	The name of the pod.	gcs-prod-websocket-eip-telecom
Namespace	boolean	The name of the namespace.	default-aliyun
ResourceScope	boolean	The pod scope.	FDN
Status	boolean	The status of the pod.	RUNNING
RequestId	string	The ID of the request.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
RequestRepeated	boolean	Indicates whether the request is repeated.	false
TcpPorts	string	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-5myukg7hnpbto7m024002****",
  "InstanceIp": "120.26.XX.XX",
  "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 code	Error code	Error message	Description
400	MissingParameter	The input parameter that is mandatory for processing this request is not supplied.	-
400	NoPermission	Permission denied.	-
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.	-
400	InvalidParameter	The errorMessage is %s. Please check it again.	-
400	LimitExceeded.SecurityGroup	The number of securityGroup exceeds the limit.	-
400	ens.interface.error	An error occurred while calling the API.	-
400	CallInterface	Call 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 time	Summary of changes	Operation
2023-12-26	API Description Update. The Error code has changed	View Change Details