Use DescribeServcieSchedule to query the real-time status of an instance or container by UUID - ENS

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ens:DescribeServcieSchedule

*All Resource

*

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 elements

Element	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	object
ContainerStatus	array<object>	The information about the container.
	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

Success response

JSON format

{
  "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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.