DescribeServcieSchedule - 查询终端客户调度信息 - 边缘节点服务ENS

调用DescribeServcieSchedule查询Uuid正在占用的（调度中）实例设备或容器实时状态。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

ens:DescribeServcieSchedule

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
AppId	string	是	应用 ID。该值通过调用 CreateApplication 创建应用后获取。	474bdef0-d149-4695-abfb-52912d91****
Uuid	string	是	终端设备唯一 ID。该值通过调用 RunServiceSchedule 并设置 ServiceAction=Start 启动服务调度后获取。	hdm_f022bf160dc69e2d8eb421e508eb****
PodConfigName	string	否	无效参数。	android

返回参数

名称	类型	描述	示例值
	object
Index	integer	调度的目标虚拟设备（容器 Pod）索引号。	2
InstanceId	string	调度的目标实例 ID。	i-5myukg7hnpbto7m024002****
InstanceIp	string	调度的目标实例 IP。	120.26.XX.XX
InstancePort	integer	调度的目标实例 Port 起始端口。	3306
PodAbstractInfo	object	调度的虚拟设备 POD 的摘要信息。
ContainerService	boolean	容器服务名。	android
ContainerStatuses	object
ContainerStatus	array<object>	容器信息列表。
	object	容器信息。
ContainerId	string	容器 ID。	container_e79_1638372147094_158091_02_000001
Name	string	容器名称。	nginx
Name	boolean	POD 名。	gcs-prod-websocket-eip-telecom
Namespace	boolean	Namespace 名称。	default-aliyun
ResourceScope	boolean	POD 所在 Scope。	FDN
Status	boolean	POD 状态。	RUNNING
RequestId	string	请求 ID。	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
RequestRepeated	boolean	是否已创建。	false
TcpPorts	string	调度的目标虚机实例/容器的 tcp 服务端口范围，取值格式：${from}-${to}，如 80-88。	80-88

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
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.	接口调用出错。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。