DescribeCloudAssistantStatus--云服务器-火山引擎

文档中心

立即注册

导航

云服务器

DescribeCloudAssistantStatus

最近更新时间：2024.06.27 18:00:11首次发布时间：2023.09.04 15:43:19

调用DescribeCloudAssistantStatus接口，查询实例批量作业客户端的安装状态。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

名称	类型	是否必填	示例值	描述
Action	String	是	DescribeCloudAssistantStatus	要执行的操作，取值：DescribeCloudAssistantStatus。
Version	String	是	2020-04-01	接口的版本，取值：2020-04-01。
InstanceIds.N	String	否	InstanceIds.1=i-yci89z1gpml8j1**&InstanceIds.2=i-cdhsdl9l8j1**	实例ID，最多支持100个ID。您可以调用DescribeInstances接口查询获取实例ID。参数 - N：表示实例的序号。多个Instance ID之间用&分隔。
OSType	String	否	linux	操作系统类型。取值： linux：实例使用linux操作系统。 windows：实例使用windows操作系统。
PageNumber	Integer	否	1	当前页码。起始值：1。默认值：1。
PageSize	Integer	否	1	分页查询时设置的每页行数。取值范围：1~100。默认值：10。
ClientVersion	String	否	v1.1.0	Agent运行版本。
Status	String	否	Running	Agent状态。取值： Running：运行中。 Updating：升级中。 Error：错误。 Lost：心跳超时。 ReadyReboot：待重启。 InstallFailed：安装失败。 Uninstalling：卸载中。 Initializing：初始化。

返回数据

名称	类型	示例值	描述
PageSize	Integer	10	分页查询时设置的每页行数。
PageNumber	Integer	1	当前页码。
TotalCount	Integer	9	已安装批量作业客户端的实例总个数。
Instances	Array of Struct	-	符合条件的实例信息。具体请参见下表“Instance 结构”。

Instance 结构

名称	类型	示例值	描述
InstanceId	String	i-yci89z1gpml8j1****	实例 ID。
InstanceName	String	实例-3	实例名称。
OSType	String	linux	操作系统类型。
OSVersion	String	CentOS 7.9 64位	操作系统版本。
HostName	String	iv-yci89z1gpml8j1****	主机名。
ClientVersion	String	v1.1.0	批量作业客户端版本。
LastHeartbeatTime	String	2023-07-01T09:00:45Z	收到最后一个心跳包的时间，即客户端最后在线时间。
Status	String	Running	实例的状态。

请求示例

GET /?Action=DescribeCloudAssistantStatus&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: ecs

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202106111445100102252431000052****",
        "Action": "DescribeCloudAssistantStatus",
        "Version": "2020-04-01",
        "Service": "ecs",
        "Region": "cn-beijing"
    },
    "Result": {
        "pageNumber": 1,
        "pageSize": 10,
        "totalCount": 1,
        "Instances": [
            {
                    "InstanceId": "i-yci89z1gpml8j1****",
                    "InstanceName": "实例-3",
                    "OSType": "linux",
                    "OSVersion": "CentOS 7.9 64位",
                    "HostName": "i-yci89z1gpml8j1****",
                    "ClientVersion": "v1.1.0",
                    "LastHeartbeatTime": "2023-07-01T09:00:45Z",
                    "Status": "Running"
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。