文档中心

云服务器

请输入

云助手

DescribeCloudAssistantStatus - 查询实例云助手Agent的安装状态

调用DescribeCloudAssistantStatus接口，查询实例云助手客户端的安装状态。

调试

API Explorer

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

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeCloudAssistantStatus

要执行的操作，取值：DescribeCloudAssistantStatus。

Version string 必选示例值：2020-04-01

API的版本，取值：2020-04-01。

InstanceIds.N string[] 可选示例值：InstanceIds.1=i-sdvgs****

实例ID，最多支持100个ID。您可以调用DescribeInstances接口查询获取实例ID。

参数 - N：表示实例的序号。

多个Instance ID之间用&分隔。

OSType string 可选示例值：linux

操作系统类型。取值：

linux：实例使用linux操作系统。

windows：实例使用windows操作系统。

ClientVersion string 可选示例值：v1.9.0

Agent运行版本。

Status string 可选示例值：Running

Agent状态。取值：

Running：运行中。

Updating：升级中。

Error：错误。

Lost：心跳超时。

ReadyReboot：待重启。

InstallFailed：安装失败。

Uninstalling：卸载中。

Initializing：初始化。

PageNumber integer 可选示例值：1

当前页码。

起始值：1。

默认值：1。

PageSize integer 可选示例值：10

分页查询时设置的每页行数。

取值范围：1~100。

默认值：10。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

PageNumber integer 示例值：1

当前页码。

PageSize integer 示例值：10

分页查询时设置的每页行数。

TotalCount integer 示例值：100

已安装Agent实例的总个数。

Instances object[] 示例值：--

符合条件的实例信息。

InstanceId string 示例值：i-yci89z1gpml8j1\*\*\*\*

实例 ID。

InstanceName string 示例值：实例-3

实例名称。

OSType string 示例值：linux

操作系统类型。

OSVersion string 示例值：CentOS 7.9 64位

操作系统版本。

HostName string 示例值：iv-yci89z1gpml8j1\*\*\*\*

主机名。

LastHeartbeatTime string 示例值：2023-07-01T09:00:45Z

收到最后一个心跳包的时间（可以理解为最后在线时间）。

Status string 示例值：Running

Agent状态。

ClientVersion string 示例值：v1.1.0

客户端版本。

请求示例

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

返回示例

{​
    "ResponseMetadata": {​
        "RequestId": "202408201648201****",​
        "Action": "DescribeCloudAssistantStatus",​
        "Version": "2020-04-01",​
        "Service": "ecs",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "PageSize": 10,​
        "PageNumber": 1,​
        "TotalCount": 1,​
        "Instances": [​
            {​
                "InstanceId": "i-ycgk0k*****",​
                "InstanceName": "",​
                "OSType": "linux",​
                "OSVersion": "5.14****",​
                "HostName": "",​
                "ClientVersion": "v1.9.0",​
                "LastHeartbeatTime": "2024-08-20T12:18:56Z",​
                "Status": "Running"​
            }​
        ]​
    }​
}​

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	MissingParameter.AccountId	The required parameter AccountId is not supplied.	用户ID不能为空。
400	InvalidOSType.Malformed	The specified OSType is malformed.	指定的操作系统类型不合法。
400	InvalidStatus.Malformed	The specified Status is malformed.	指定的 Agent 状态不合法。
400	InvalidClientVersion.Malformed	The specified ClientVersion is malformed.	指定的客户端运行版本不合法。
400	LimitExceeded.MaximumInstanceIds	The specified InstanceIds exceeds the limit.	实例数量超出限制。
400	InvalidRegion	Service [ecs] is not available in region [ap-guangzhou].	指定的地域无效
500	InternalError	An internal error has occurred.	内部错误，请重试。如果多次尝试失败，请提交工单。

最近更新时间：2025.09.04 16:54:57

这个页面对您有帮助吗？

有用

无用