高性能应用服务 HAI 查询实例

1. 接口描述

接口请求域名： hai.tencentcloudapi.com 。

本接口（DescribeInstances）用户查询实例

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeInstances。
Version	是	String	公共参数，本接口取值：2023-08-12。
Region	是	String	公共参数，详见产品支持的地域列表。
InstanceIds.N	否	Array of String	实例元组，数量上限100 示例值：["hai-12345678"]
Filters.N	否	Array of Filter	描述键值对过滤器，用于条件过滤查询。目前支持的过滤器有： instance-id，实例id； instance-state，实例状态：RUNNING，PENDING，STOPPED，ARREARS，STOPPED_NO_CHARGE； charge-type，付费方式：PREPAID_BY_MONTH，POSTPAID_BY_HOUR； public-ip-address，公网IP过滤示例值：[{"Name":"instance-state", "Values":["RUNNING"]}]
Offset	否	Integer	偏移量，默认为0，不得大于100 示例值：0
Limit	否	Integer	返回量，默认为20，不能小于0 示例值：20

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	实例总数示例值：1
InstanceSet	Array of Instance	分页实例详情示例值：[{"InstanceId":"hai-jklfaded"}]
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查看指定实例hai-jklfaded的信息

查看指定实例hai-jklfaded的信息

输入示例

POST / HTTP/1.1
Host: hai.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstances
<公共请求参数>

{
    "InstanceIds": [
        "hai-jklfaded"
    ],
    "Offset": 0,
    "Limit": 1
}

输出示例

{
    "Response": {
        "TotalCount": 10,
        "InstanceSet": [
            {
                "InstanceId": "hai-jklfaded",
                "InstanceName": "hai",
                "InstanceState": "RUNNING",
                "ApplicationName": "pytorch",
                "BundleName": "基础型",
                "GPUPerformance": "8+TFlops",
                "GPUMemory": "16+GB",
                "CPU": "20C",
                "Memory": "80GB",
                "SystemDisk": {
                    "DiskType": "CLOUD_SSD",
                    "DiskSize": 80
                },
                "PrivateIpAddresses": [
                    "1.1.1.1"
                ],
                "PublicIpAddresses": [
                    "2.2.2.2"
                ],
                "SecurityGroupIds": [
                    "sg-xxxxxxxx"
                ],
                "LatestOperation": "RunInstances",
                "LatestOperationState": "SUCCESS",
                "CreateTime": "2023-08-01 00:00:00",
                "MaxOutBandwidth": "10Mbps",
                "MaxFreeTraffic": "1000GB",
                "ConfigurationEnvironment": "cuda 10 | pytorch | tensorflow",
                "LoginServices": [
                    {
                        "ServiceName": "jupyter"
                    }
                ],
                "OSType": "linux"
            }
        ],
        "RequestId": "41fa870d-8592-493c-b794-9fe19f23e800"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
InternalError	内部错误。
InvalidParameter.AtMostOne	两个指定的入参每次只能使用其中一个
InvalidParameterValue	参数取值错误。
InvalidParameterValue.Duplicated	列表入参中存在重复值
InvalidParameterValue.InvalidInstanceIdMalformed	实例ID格式非法
UnauthorizedOperation.UnauthorizedUser	客户未授权使用本产品

近期搜索热词

云服务器

云硬盘

容器服务

负载均衡

弹性伸缩

云函数

私有网络

批量计算

专线接入

对象存储

微服务平台 TSF

文件存储

全站加速网络

消息队列 CKafka 版

日志服务

云数据库 MySQL

云数据库 MariaDB

云数据库 SQL Server

云数据库 PostgreSQL

时序数据库 CTSDB

网络流日志

云数据库 Redis®

内容分发网络 CDN

云数据库 Memcached

云数据库 MongoDB

TDSQL MySQL版

全球应用加速

数据传输服务

云拨测

腾讯云区块链服务平台 TBaaS

主机安全

访问管理

DDoS 防护

标签

Web 应用防火墙

密钥管理系统

域名注册

操作审计

SSL 证书

短信

数据万象

NLP 技术

云点播

云加密机

云市场

云安全中心

云开发 CloudBase

流计算 Oceanus

腾讯云数据仓库 TCHouse-P

人脸识别

集团账号管理

图像识别

文字识别

Elasticsearch Service

口语评测（基础版）

媒体处理

云直播

云联络中心

物联网通信

机器翻译

人脸融合

弹性 MapReduce

游戏数据库 TcaplusDB

游戏多媒体引擎

腾讯云 BI

实时音视频

TI-ONE 训练平台

渠道合作伙伴

数据安全审计

智能视图计算平台

数据安全治理中心

消息队列 RocketMQ 版

微瓴同业开放平台

腾讯云数据仓库 TCHouse-C

云数据库 KeeWiDB

实时互动-教育版

商场客留大数据

腾讯云健康看板

设备安全