接口请求域名: cvm.tencentcloudapi.com 。
本接口 (DescribeInstances) 用于查询一个或多个实例的详细信息。
ID
、实例名称或者实例计费模式等信息来查询实例的详细信息。过滤信息详细请见过滤器Filter
。Limit
所指定的数量,默认为20)的实例。默认接口请求频率限制:40次/秒。
注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:cvm.ap-shanghai-fsi.tencentcloudapi.com。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeInstances。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-12。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
InstanceIds.N | 否 | Array of String | 按照一个或者多个实例ID查询。实例ID形如:ins-xxxxxxxx 。(此参数的具体格式可参考API简介的ids.N 一节)。每次请求的实例的上限为100。参数不支持同时指定InstanceIds 和Filters 。 |
Filters.N | 否 | Array of Filter | 按照【可用区】进行过滤。可用区形如:ap-guangzhou-1。 类型:String 必选:否 可选项:可用区列表 按照【项目ID】进行过滤,可通过调用DescribeProject查询已创建的项目列表或登录控制台进行查看;也可以调用AddProject创建新的项目。项目ID形如:1002189。 类型:Integer 必选:否 按照【CDH ID】进行过滤。CDH ID形如:host-xxxxxxxx。 类型:String 必选:否 按照【VPC ID】进行过滤。VPC ID形如:vpc-xxxxxxxx。 类型:String 必选:否 按照【子网ID】进行过滤。子网ID形如:subnet-xxxxxxxx。 类型:String 必选:否 按照【实例ID】进行过滤。实例ID形如:ins-xxxxxxxx。 类型:String 必选:否 按照【实例UUID】进行过滤。实例UUID形如:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx。 类型:String 必选:否 按照【安全组ID】进行过滤。安全组ID形如: sg-8jlk3f3r。 类型:String 必选:否 按照【实例名称】进行过滤。 类型:String 必选:否 按照【实例计费模式】进行过滤。(PREPAID:表示预付费,即包年包月 | POSTPAID_BY_HOUR:表示后付费,即按量计费 | CDHPAID:表示CDH付费,即只对CDH计费,不对CDH上的实例计费。) 类型:String 必选:否 按照【实例状态】进行过滤。状态类型详见实例状态表 类型:String 必选:否 按照【实例主网卡的内网IP】进行过滤。 类型:String 必选:否 按照【实例主网卡的公网IP】进行过滤,包含实例创建时自动分配的IP和实例创建后手动绑定的弹性IP。 类型:String 必选:否 按照【实例的IPv6地址】进行过滤。 类型:String 必选:否 按照【标签键】进行过滤。 类型:String 必选:否 按照【标签值】进行过滤。 类型:String 必选:否 按照【标签键值对】进行过滤。tag-key使用具体的标签键进行替换。使用请参考示例2。 类型:String 必选:否 每次请求的 Filters 的上限为10,Filter.Values 的上限为5。参数不支持同时指定InstanceIds 和Filters 。 |
Offset | 否 | Integer | 偏移量,默认为0。关于Offset 的更进一步介绍请参考 API 简介中的相关小节。 |
Limit | 否 | Integer | 返回数量,默认为20,最大值为100。关于Limit 的更进一步介绍请参考 API 简介中的相关小节。 |
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 符合条件的实例数量。 |
InstanceSet | Array of Instance | 实例详细信息列表。 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
查看在广州一区或广州二区的实例信息,限制返回结果最多为一项
GET https://cvm.tencentcloudapi.com/?Action=DescribeInstances
&Filters.0.Name=zone
&Filters.0.Values.0=ap-guangzhou-1
&Filters.0.Values.1=ap-guangzhou-2
&Offset=0
&Limit=1
&<公共请求参数>
{
"Response": {
"InstanceSet": [
{
"RenewFlag": "null",
"Uuid": "68b510db-b4c1-4630-a62b-73d0c7c970f9",
"InstanceState": "RUNNING",
"LatestOperationState": "SUCCESS",
"OsName": "CentOS 7.6 64bit",
"CreatedTime": "2020-03-10T02:43:51Z",
"RestrictState": "NORMAL",
"ExpiredTime": "2020-04-10T02:47:36Z",
"DisasterRecoverGroupId": "",
"Memory": 1,
"IPv6Addresses": null,
"CPU": 1,
"CamRoleName": "",
"PublicIpAddresses": [
"123.207.11.190"
],
"Tags": [],
"InstanceId": "ins-9bxebleo",
"ImageId": "img-9qabwvbn",
"StopChargingMode": "NOT_APPLICABLE",
"InstanceChargeType": "PREPAID",
"InstanceType": "S1.SMALL1",
"SystemDisk": {
"DiskSize": 50,
"DiskId": "disk-nucurerk",
"DiskType": "CLOUD_PREMIUM"
},
"Placement": {
"ProjectId": 1174660,
"HostId": null,
"Zone": "ap-guangzhou-2"
},
"PrivateIpAddresses": [
"172.16.32.78"
],
"LoginSettings": {
"KeyIds": null
},
"SecurityGroupIds": [
"sg-p1ezv4wz"
],
"InstanceName": "测试实例",
"DataDisks": null,
"VirtualPrivateCloud": {
"SubnetId": "subnet-a2676p0e",
"AsVpcGateway": false,
"VpcId": "vpc-g7wzcv7n"
},
"LatestOperationRequestId": "3554eb5b-1cfa-471a-ae76-dc436c9d43e8",
"InternetAccessible": {
"InternetMaxBandwidthOut": 1,
"InternetChargeType": "BANDWIDTH_PREPAID"
},
"LatestOperation": "RenewInstances"
}
],
"TotalCount": 2,
"RequestId": "62DDFFC6-FDB5-44F7-20A6-59152E3D129A"
}
}
查询绑定了标签键值对(city:shenzhen)的实例。
GET https://cvm.tencentcloudapi.com/?Action=DescribeInstances
&Filters.0.Name=tag:city
&Filters.0.Values.0=shenzhen
&Offset=0
&Limit=1
&<公共请求参数>
{
"Response": {
"InstanceSet": [
{
"RenewFlag": "NOTIFY_AND_MANUAL_RENEW",
"Uuid": "68b510db-b4c1-4630-a62b-73d0c7c970f9",
"InstanceState": "RUNNING",
"LatestOperationState": "SUCCESS",
"OsName": "CentOS 7.6 64bit",
"CreatedTime": "2020-03-10T02:43:51Z",
"RestrictState": "NORMAL",
"ExpiredTime": "2020-04-10T02:47:36Z",
"DisasterRecoverGroupId": "",
"Memory": 1,
"IPv6Addresses": null,
"CPU": 1,
"CamRoleName": "",
"PublicIpAddresses": [
"123.207.11.190"
],
"Tags": [
{
"Value": "shenzhen",
"Key": "city"
}
],
"InstanceId": "ins-9bxebleo",
"ImageId": "img-9qabwvbn",
"StopChargingMode": "NOT_APPLICABLE",
"InstanceChargeType": "PREPAID",
"InstanceType": "S1.SMALL1",
"SystemDisk": {
"DiskSize": 50,
"DiskId": "disk-nucurerk",
"DiskType": "CLOUD_PREMIUM"
},
"Placement": {
"ProjectId": 1174660,
"HostId": null,
"Zone": "ap-guangzhou-2"
},
"PrivateIpAddresses": [
"172.16.32.78"
],
"LoginSettings": {
"KeyIds": null
},
"SecurityGroupIds": [
"sg-p1ezv4wz"
],
"InstanceName": "测试实例",
"DataDisks": null,
"VirtualPrivateCloud": {
"SubnetId": "subnet-a2676p0e",
"AsVpcGateway": false,
"VpcId": "vpc-g7wzcv7n"
},
"LatestOperationRequestId": "3554eb5b-1cfa-471a-ae76-dc436c9d43e8",
"InternetAccessible": {
"InternetMaxBandwidthOut": 1,
"InternetChargeType": "BANDWIDTH_PREPAID"
},
"LatestOperation": "RenewInstances"
}
],
"TotalCount": 1,
"RequestId": "62DDFFC6-FDB5-44F7-20A6-59152E3D129A"
}
}
当对实例发起 StopInstances 后,通过 DescribeInstances 可以查询到实例的 LatestOperation 为 StopInstances,LatestOperationState 为 OPERATING。
GET https://cvm.tencentcloudapi.com/?Action=DescribeInstances
&Filters.0.Name=zone
&Filters.0.Values.0=ap-guangzhou-1
&Filters.0.Values.1=ap-guangzhou-2
&Offset=0
&Limit=1
&<公共请求参数>
{
"Response": {
"InstanceSet": [
{
"RenewFlag": "null",
"Uuid": "68b510db-b4c1-4630-a62b-73d0c7c970f9",
"InstanceState": "STOPPING",
"LatestOperationState": "OPERATING",
"OsName": "CentOS 7.6 64bit",
"CreatedTime": "2020-03-10T02:43:51Z",
"RestrictState": "NORMAL",
"ExpiredTime": "2020-04-10T02:47:36Z",
"DisasterRecoverGroupId": "",
"Memory": 1,
"IPv6Addresses": null,
"CPU": 1,
"CamRoleName": "",
"PublicIpAddresses": [
"123.207.11.190"
],
"Tags": [],
"InstanceId": "ins-9bxebleo",
"ImageId": "img-9qabwvbn",
"StopChargingMode": "NOT_APPLICABLE",
"InstanceChargeType": "PREPAID",
"InstanceType": "S1.SMALL1",
"SystemDisk": {
"DiskSize": 50,
"DiskId": "disk-nucurerk",
"DiskType": "CLOUD_PREMIUM"
},
"Placement": {
"ProjectId": 1174660,
"HostId": null,
"Zone": "ap-guangzhou-2"
},
"PrivateIpAddresses": [
"172.16.32.78"
],
"LoginSettings": {
"KeyIds": null
},
"SecurityGroupIds": [
"sg-p1ezv4wz"
],
"InstanceName": "测试实例",
"DataDisks": null,
"VirtualPrivateCloud": {
"SubnetId": "subnet-a2676p0e",
"AsVpcGateway": false,
"VpcId": "vpc-g7wzcv7n"
},
"LatestOperationRequestId": "2f8decef-78b2-4e20-bcfe-7a5112658a05",
"InternetAccessible": {
"InternetMaxBandwidthOut": 1,
"InternetChargeType": "BANDWIDTH_PREPAID"
},
"LatestOperation": "StopInstances"
}
],
"TotalCount": 2,
"RequestId": "62DDFFC6-FDB5-44F7-20A6-59152E3D129A"
}
}
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.IllegalTagKey | 标签键存在不合法字符 |
FailedOperation.IllegalTagValue | 标签值存在不合法字符。 |
FailedOperation.TagKeyReserved | 请求中指定的标签键为系统预留标签,禁止创建 |
InternalServerError | 操作内部错误。 |
InvalidFilter | 无效的过滤器。 |
InvalidFilterValue.LimitExceeded | Filter 。 |
InvalidHostId.Malformed | 无效CDH ID 。指定的CDH ID 格式错误。例如ID 长度错误host-1122 。 |
InvalidInstanceId.Malformed | 无效实例ID 。指定的实例ID 格式错误。例如实例ID 长度错误ins-1122 。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.IPAddressMalformed | IP格式非法。 |
InvalidParameterValue.InvalidIpFormat | IP地址不符合规范 |
InvalidParameterValue.LimitExceeded | 参数值数量超过限制。 |
InvalidParameterValue.SubnetIdMalformed | 子网ID不合要求,请提供规范的子网ID,类似subnet-xxxxxxxx,字母x代表小写字符或者数字 |
InvalidParameterValue.TagKeyNotFound | 指定的标签不存在。 |
InvalidParameterValue.VpcIdMalformed | VPC IDxxx 不合要求,请提供规范的Vpc ID, 类似vpc-xxxxxxxx,字母x代表小写字符或者数字。 |
InvalidSecurityGroupId.NotFound | 指定的安全组ID 不存在。 |
InvalidSgId.Malformed | 指定的安全组ID 格式错误,例如实例ID 长度错误sg-ide32 。 |
InvalidZone.MismatchRegion | 指定的zone 不存在。 |
ResourceNotFound.HpcCluster | 高性能计算集群不存在。 |
UnauthorizedOperation.InvalidToken | 请确认Token是否有效。 |
客户简介 全民直播是一家涵盖游戏、娱乐、户外等多领域泛娱乐的直播平台。2015年...
??提到慕尼黑,大家第一个想到总是啤酒节,其实慕尼黑的文化同样闻名世界。慕尼...
3月24日,腾讯发布2020年Q4及全年财报,其中金融科技及企业服务第四季收入385亿...
API风格说明 当前ECS服务对外开放两类风格的API: ECS服务自定义规范的API(以下...
案例背景 高校健康打卡项目发起于北京大学软件与微电子学院,是该学院张齐勋老师...
排查思路 无法通过远程桌面连接裸金属服务器时,我们推荐您按照以下思路排查问题...
客户简介 趣医网(quyiyuan.com)创立于2014年,为京颐集团重要成员企业之一,是...
注册了 域名 不备案可以吗?可以的。 注册域名 并不是一定要备案的,只有搭 建网...
公司介绍 我们公司是全球法律服务整合平台,已有的4万多名律师遍布全国359个城市...
云虚拟主机 可以干什么?云 虚拟主机 可以是搭 建网站 的重要产品,可用来存放网...