1. 接口描述
接口请求域名： ecm.tencentcloudapi.com 。
获取实例的相关信息。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeInstances。 |
| Version | 是 | String | 公共参数，本接口取值：2019-07-19。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Filters.N | 否 | Array of Filter | 过滤条件。 zone String 是否必填：否 （过滤条件）按照可用区英文标识符过滤。 zone-name String 是否必填：否 （过滤条件）按照可用区中文名过滤,支持模糊匹配。 module-id String 是否必填：否 （过滤条件）按照模块ID过滤。 instance-id String 是否必填：否 （过滤条件）按照实例ID过滤。 instance-name String 是否必填：否 （过滤条件）按照实例名称过滤,支持模糊匹配。 ip-address String 是否必填：否 （过滤条件）按照实例的内网/公网IP过滤。 instance-uuid string 是否必填：否 （过滤条件）按照uuid过滤实例列表。 instance-state string 是否必填：否 （过滤条件）按照实例状态更新实例列表。 internet-service-provider String 是否必填：否 （过滤条件）按照实例公网IP所属的运营商进行过滤。 tag-key String 是否必填：否 （过滤条件）按照标签键进行过滤。 tag:tag-key String 是否必填：否 （过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。 instance-family String 是否必填：否 （过滤条件）按照机型family过滤。 module-name String 是否必填：否 （过滤条件）按照模块名称过滤,支持模糊匹配。 image-id String 是否必填：否 （过滤条件）按照实例的镜像ID过滤。 vpc-id String 是否必填：否 （过滤条件）按照实例的vpc id过滤。 subnet-id String 是否必填：否 （过滤条件）按照实例的subnet id过滤。 若不传Filters参数则表示查询所有相关的实例信息。 单次请求的Filter.Values的上限为5。 示例值：{"Filters":[{"Values":["ap-ningbo-ecm2-1"],"Name":"zone"}]} |
| Offset | 否 | Integer | 偏移量，默认为0。 示例值：10 |
| Limit | 否 | Integer | 返回数量，默认为20(如果查询结果数目大于等于20)，最大值为100。 示例值：10 |
| OrderByField | 否 | String | 指定排序字段。目前支持的可选值如下 timestamp 按实例创建时间排序。 注意：目前仅支持按创建时间排序，后续可能会有扩展。 如果不传，默认按实例创建时间排序 示例值：timestamp |
| OrderDirection | 否 | Integer | 指定排序是降序还是升序。0表示降序； 1表示升序。如果不传默认为降序 示例值：0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCount | Integer | 返回的实例相关信息列表的长度。 示例值：5 |
| InstanceSet | Array of Instance | 返回的实例相关信息列表。 注意：此字段可能返回 null，表示取不到有效值。 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 用vpc-id查询实例
输入示例
POST / HTTP/1.1
Host: ecm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstances
<公共请求参数>
{
"Filters": [
{
"Values": [
"vpc-ec3mnb4d"
],
"Name": "vpc-id"
}
]
}输出示例
{
"Response": {
"RequestId": "",
"InstanceSet": [
{
"DataDiskSize": 0,
"RestrictState": "NORMAL",
"InstanceId": "ein-bb0ab3pc",
"ISP": "CTCC",
"SecurityGroupIds": [],
"SystemDisk": {
"DeleteWithInstance": false,
"DiskType": "LOCAL_BASIC",
"DiskId": "ldisk-91p8tj1p",
"DiskSize": 50,
"SnapshotId": ""
},
"ExpireTime": "2020-09-27 16:13:51",
"TagSet": null,
"SimpleModule": {
"ModuleId": "em-5wrpefy1",
"ModuleName": "jiaxuan"
},
"DataDisks": null,
"LatestOperationState": "SUCCESS",
"UUID": "3c3e605a-33a0-41ca-9251-5f115a531c3e",
"SystemDiskSize": 50,
"InstanceTypeConfig": {
"Frequency": "2.5 GHz",
"GpuModelName": null,
"InstanceType": "SN3ne.2XLARGE16",
"Vcpu": 8,
"Vgpu": null,
"InstanceFamilyConfig": {
"InstanceFamilyName": "标准型SN3ne",
"InstanceFamily": "SN3ne"
},
"InstanceFamilyTypeConfig": {
"InstanceFamilyTypeName": "标准型",
"InstanceFamilyType": "S"
},
"CpuModelName": "Intel Xeon Skylake 6133",
"Memory": 16,
"ExtInfo": ""
},
"RenewFlag": 0,
"VirtualPrivateCloud": {
"PrivateIpAddresses": [
"10.11.12.6"
],
"VpcId": "vpc-95ytv1vr",
"AsVpcGateway": false,
"SubnetId": "subnet-fua8fff8",
"Ipv6AddressCount": 0
},
"IsolatedTime": "2020-09-27 16:13:51",
"InstanceName": "jiaxuan滨海_勿删2",
"Position": {
"ZoneInfo": {
"ZoneId": 12000001,
"Zone": "ap-bhmini-ecm-1",
"ZoneName": "腾讯滨海专区"
},
"Country": {
"CountryName": "中国",
"CountryId": "china"
},
"Ipv6Supported": true,
"Area": {
"AreaName": "华南",
"AreaId": "china-south"
},
"Province": {
"ProvinceId": "china-south-guangdong",
"ProvinceName": "广东"
},
"City": {
"CityName": "深圳",
"CityId": "china-south-guangdong-shenzhen"
},
"RegionInfo": {
"RegionId": 0,
"Region": "ap-bhmini-ecm",
"RegionName": "腾讯滨海专区"
}
},
"CreateTime": "2020-09-27 16:13:51",
"Image": {
"SrcImage": {
"InstanceName": "",
"InstanceId": "",
"ImageOsName": "centos_test",
"ImageId": "img-test",
"ImageName": "centos",
"RegionID": 20,
"RegionName": "上海",
"ImageType": "",
"ImageDescription": "info_test",
"Region": "ap-shanghai"
},
"ImageOsName": "CentOS 7.6 64位",
"ImageId": "img-9qabwvbn",
"Platform": "CentOS",
"ImageName": "CentOS 7.6 64位",
"ImageCreateTime": "",
"ImageOwner": 0,
"ImageSource": "OFFICIAL",
"ImageType": "PUBLIC_IMAGE",
"IsSupportCloudInit": true,
"OsType": "linux",
"OsVersion": "7.6.0",
"ImageState": "NORMAL",
"ImageDescription": "CentOS 7.6 64位",
"Architecture": "x86_64",
"ImageSize": 50,
"TaskId": ""
},
"InstanceState": "RUNNING",
"Internet": {
"InstanceNetworkInfoSet": [
{
"Primary": true,
"NetworkInterfaceId": "eni-m5gnw3tv",
"NetworkInterfaceName": "ein-bb0ab3pc Primary ENI",
"AddressInfoSet": [
{
"PublicIPAddressInfo": {
"PublicIPAddress": "118.126.126.23",
"ISP": {
"ISPName": "电信",
"ISPId": "CTCC"
},
"MaxBandwidthOut": 25,
"ChargeMode": "BANDWIDTH_PACKAGE",
"MaxBandwidthIn": 0
},
"PrivateIPAddressInfo": {
"PrivateIPAddress": "10.11.12.6"
}
}
]
}
],
"PrivateIPAddressSet": [
{
"PrivateIPAddress": "10.11.12.6"
}
],
"PublicIPAddressSet": [
{
"PublicIPAddress": "118.126.126.23",
"ISP": {
"ISPName": "电信",
"ISPId": "CTCC"
},
"MaxBandwidthOut": 25,
"ChargeMode": "BANDWIDTH_PACKAGE",
"MaxBandwidthIn": 0
}
]
},
"NewFlag": 0,
"ExpireState": "NORMAL",
"PayMode": 0,
"PhysicalPosition": {
"PosId": "",
"RackId": "",
"SwitchId": ""
},
"LatestOperation": "ResetInstancesPassword"
},
{
"DataDiskSize": 0,
"RestrictState": "NORMAL",
"InstanceId": "ein-b6kee4dg",
"ISP": "CTCC",
"SecurityGroupIds": [],
"SystemDisk": {
"DeleteWithInstance": false,
"DiskType": "LOCAL_BASIC",
"DiskId": "ldisk-9tvkpn8p",
"DiskSize": 50,
"SnapshotId": ""
},
"ExpireTime": "2020-09-27 16:12:24",
"TagSet": null,
"SimpleModule": {
"ModuleId": "em-xgi6r1hk",
"ModuleName": "视频V8-cedricliu"
},
"DataDisks": null,
"LatestOperationState": "SUCCESS",
"UUID": "edf97143-b1e3-43d9-b34b-cfcf3fba1820",
"SystemDiskSize": 50,
"InstanceTypeConfig": {
"Frequency": "2.5 GHz",
"GpuModelName": null,
"InstanceType": "SN3ne.4XLARGE32",
"Vcpu": 16,
"Vgpu": null,
"InstanceFamilyConfig": {
"InstanceFamilyName": "标准型SN3ne",
"InstanceFamily": "SN3ne"
},
"InstanceFamilyTypeConfig": {
"InstanceFamilyTypeName": "标准型",
"InstanceFamilyType": "S"
},
"CpuModelName": "Intel Xeon Skylake 6133",
"Memory": 32,
"ExtInfo": ""
},
"RenewFlag": 0,
"VirtualPrivateCloud": {
"PrivateIpAddresses": [
"10.11.12.17"
],
"VpcId": "vpc-95ytv1vr",
"AsVpcGateway": false,
"SubnetId": "subnet-fua8fff8",
"Ipv6AddressCount": 0
},
"IsolatedTime": "2020-09-27 16:12:24",
"InstanceName": "jiaxuan滨海机器_勿删2",
"Position": {
"ZoneInfo": {
"ZoneId": 12000001,
"Zone": "ap-bhmini-ecm-1",
"ZoneName": "腾讯滨海专区"
},
"Country": {
"CountryName": "中国",
"CountryId": "china"
},
"Ipv6Supported": true,
"Area": {
"AreaName": "华南",
"AreaId": "china-south"
},
"Province": {
"ProvinceId": "china-south-guangdong",
"ProvinceName": "广东"
},
"City": {
"CityName": "深圳",
"CityId": "china-south-guangdong-shenzhen"
},
"RegionInfo": {
"RegionId": 0,
"Region": "ap-bhmini-ecm",
"RegionName": "腾讯滨海专区"
}
},
"CreateTime": "2020-09-27 16:12:24",
"Image": {
"SrcImage": {
"InstanceName": "",
"InstanceId": "",
"ImageOsName": "centos_test",
"ImageId": "img-test",
"ImageName": "centos",
"RegionID": 20,
"RegionName": "上海",
"ImageType": "",
"ImageDescription": "info_test",
"Region": "ap-shanghai"
},
"ImageOsName": "CentOS 7.6 64位",
"ImageId": "img-9qabwvbn",
"Platform": "CentOS",
"ImageName": "CentOS 7.6 64位",
"ImageCreateTime": "",
"ImageOwner": 0,
"ImageSource": "OFFICIAL",
"ImageType": "PUBLIC_IMAGE",
"IsSupportCloudInit": true,
"OsType": "linux",
"OsVersion": "7.6.0",
"ImageState": "NORMAL",
"ImageDescription": "CentOS 7.6 64位",
"Architecture": "x86_64",
"ImageSize": 50,
"TaskId": ""
},
"InstanceState": "RUNNING",
"Internet": {
"InstanceNetworkInfoSet": [
{
"Primary": true,
"NetworkInterfaceId": "eni-mhym6o89",
"NetworkInterfaceName": "ein-b6kee4dg Primary ENI",
"AddressInfoSet": [
{
"PublicIPAddressInfo": {
"PublicIPAddress": "118.126.126.27",
"ISP": {
"ISPName": "电信",
"ISPId": "CTCC"
},
"MaxBandwidthOut": 105,
"ChargeMode": "BANDWIDTH_PACKAGE",
"MaxBandwidthIn": 0
},
"PrivateIPAddressInfo": {
"PrivateIPAddress": "10.11.12.17"
}
}
]
}
],
"PrivateIPAddressSet": [
{
"PrivateIPAddress": "10.11.12.17"
}
],
"PublicIPAddressSet": [
{
"PublicIPAddress": "118.126.126.27",
"ISP": {
"ISPName": "电信",
"ISPId": "CTCC"
},
"MaxBandwidthOut": 105,
"ChargeMode": "BANDWIDTH_PACKAGE",
"MaxBandwidthIn": 0
}
]
},
"NewFlag": 0,
"ExpireState": "NORMAL",
"PayMode": 0,
"PhysicalPosition": {
"PosId": "",
"RackId": "",
"SwitchId": ""
},
"LatestOperation": "ResetInstancesPassword"
},
{
"DataDiskSize": 0,
"RestrictState": "NORMAL",
"InstanceId": "ein-5uhtyyps",
"ISP": "CTCC",
"SecurityGroupIds": [],
"SystemDisk": {
"DeleteWithInstance": false,
"DiskType": "LOCAL_BASIC",
"DiskId": "ldisk-0fqlcnj7",
"DiskSize": 50,
"SnapshotId": ""
},
"ExpireTime": "2020-09-27 16:12:24",
"TagSet": null,
"SimpleModule": {
"ModuleId": "em-xgi6r1hk",
"ModuleName": "视频V8-cedricliu"
},
"DataDisks": null,
"LatestOperationState": "SUCCESS",
"UUID": "e85e02fb-8efd-4728-a3d7-10cf913ed4e5",
"SystemDiskSize": 50,
"InstanceTypeConfig": {
"Frequency": "2.5 GHz",
"GpuModelName": null,
"InstanceType": "SN3ne.4XLARGE32",
"Vcpu": 16,
"Vgpu": null,
"InstanceFamilyConfig": {
"InstanceFamilyName": "标准型SN3ne",
"InstanceFamily": "SN3ne"
},
"InstanceFamilyTypeConfig": {
"InstanceFamilyTypeName": "标准型",
"InstanceFamilyType": "S"
},
"CpuModelName": "Intel Xeon Skylake 6133",
"Memory": 32,
"ExtInfo": ""
},
"RenewFlag": 0,
"VirtualPrivateCloud": {
"PrivateIpAddresses": [
"10.11.12.4"
],
"VpcId": "vpc-95ytv1vr",
"AsVpcGateway": false,
"SubnetId": "subnet-fua8fff8",
"Ipv6AddressCount": 0
},
"IsolatedTime": "2020-09-27 16:12:24",
"InstanceName": "jiaxuan滨海机器_勿删1",
"Position": {
"ZoneInfo": {
"ZoneId": 12000001,
"Zone": "ap-bhmini-ecm-1",
"ZoneName": "腾讯滨海专区"
},
"Country": {
"CountryName": "中国",
"CountryId": "china"
},
"Ipv6Supported": true,
"Area": {
"AreaName": "华南",
"AreaId": "china-south"
},
"Province": {
"ProvinceId": "china-south-guangdong",
"ProvinceName": "广东"
},
"City": {
"CityName": "深圳",
"CityId": "china-south-guangdong-shenzhen"
},
"RegionInfo": {
"RegionId": 0,
"Region": "ap-bhmini-ecm",
"RegionName": "腾讯滨海专区"
}
},
"CreateTime": "2020-09-27 16:12:24",
"Image": {
"SrcImage": {
"InstanceName": "",
"InstanceId": "",
"ImageOsName": "centos_test",
"ImageId": "img-test",
"ImageName": "centos",
"RegionID": 20,
"RegionName": "上海",
"ImageType": "",
"ImageDescription": "info_test",
"Region": "ap-shanghai"
},
"ImageOsName": "CentOS 7.6 64位",
"ImageId": "img-9qabwvbn",
"Platform": "CentOS",
"ImageName": "CentOS 7.6 64位",
"ImageCreateTime": "",
"ImageOwner": 0,
"ImageSource": "OFFICIAL",
"ImageType": "PUBLIC_IMAGE",
"IsSupportCloudInit": true,
"OsType": "linux",
"OsVersion": "7.6.0",
"ImageState": "NORMAL",
"ImageDescription": "CentOS 7.6 64位",
"Architecture": "x86_64",
"ImageSize": 50,
"TaskId": ""
},
"InstanceState": "RUNNING",
"Internet": {
"InstanceNetworkInfoSet": [
{
"Primary": true,
"NetworkInterfaceId": "eni-i7nvrvbj",
"NetworkInterfaceName": "ein-5uhtyyps Primary ENI",
"AddressInfoSet": [
{
"PublicIPAddressInfo": {
"PublicIPAddress": "118.126.126.39",
"ISP": {
"ISPName": "电信",
"ISPId": "CTCC"
},
"MaxBandwidthOut": 105,
"ChargeMode": "BANDWIDTH_PACKAGE",
"MaxBandwidthIn": 0
},
"PrivateIPAddressInfo": {
"PrivateIPAddress": "10.11.12.4"
}
}
]
}
],
"PrivateIPAddressSet": [
{
"PrivateIPAddress": "10.11.12.4"
}
],
"PublicIPAddressSet": [
{
"PublicIPAddress": "118.126.126.39",
"ISP": {
"ISPName": "电信",
"ISPId": "CTCC"
},
"MaxBandwidthOut": 105,
"ChargeMode": "BANDWIDTH_PACKAGE",
"MaxBandwidthIn": 0
}
]
},
"NewFlag": 0,
"ExpireState": "NORMAL",
"PayMode": 0,
"PhysicalPosition": {
"PosId": "",
"RackId": "",
"SwitchId": ""
},
"LatestOperation": "ResetInstancesPassword"
}
],
"TotalCount": 12
}
}示例2 通过默认参数获取实例信息
通过默认参数来获取实例的信息。
输入示例
POST / HTTP/1.1
Host: ecm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstances
<公共请求参数>
{}输出示例
{
"Response": {
"RequestId": "",
"InstanceSet": [
{
"DataDiskSize": 0,
"RestrictState": "NORMAL",
"InstanceId": "ein-bb0ab3pc",
"ISP": "CTCC",
"SecurityGroupIds": [],
"SystemDisk": {
"DeleteWithInstance": false,
"DiskType": "LOCAL_BASIC",
"DiskId": "ldisk-91p8tj1p",
"DiskSize": 50,
"SnapshotId": ""
},
"ExpireTime": "2020-09-27 16:13:51",
"TagSet": null,
"SimpleModule": {
"ModuleId": "em-5wrpefy1",
"ModuleName": "jiaxuan"
},
"DataDisks": null,
"LatestOperationState": "SUCCESS",
"UUID": "3c3e605a-33a0-41ca-9251-5f115a531c3e",
"SystemDiskSize": 50,
"InstanceTypeConfig": {
"Frequency": "2.5 GHz",
"GpuModelName": null,
"InstanceType": "SN3ne.2XLARGE16",
"Vcpu": 8,
"Vgpu": null,
"InstanceFamilyConfig": {
"InstanceFamilyName": "标准型SN3ne",
"InstanceFamily": "SN3ne"
},
"InstanceFamilyTypeConfig": {
"InstanceFamilyTypeName": "标准型",
"InstanceFamilyType": "S"
},
"CpuModelName": "Intel Xeon Skylake 6133",
"Memory": 16,
"ExtInfo": ""
},
"RenewFlag": 0,
"VirtualPrivateCloud": {
"PrivateIpAddresses": [
"10.11.12.6"
],
"VpcId": "vpc-95ytv1vr",
"AsVpcGateway": false,
"SubnetId": "subnet-fua8fff8",
"Ipv6AddressCount": 0
},
"IsolatedTime": "2020-09-27 16:13:51",
"InstanceName": "jiaxuan滨海_勿删2",
"Position": {
"ZoneInfo": {
"ZoneId": 12000001,
"Zone": "ap-bhmini-ecm-1",
"ZoneName": "腾讯滨海专区"
},
"Country": {
"CountryName": "中国",
"CountryId": "china"
},
"Ipv6Supported": true,
"Area": {
"AreaName": "华南",
"AreaId": "china-south"
},
"Province": {
"ProvinceId": "china-south-guangdong",
"ProvinceName": "广东"
},
"City": {
"CityName": "深圳",
"CityId": "china-south-guangdong-shenzhen"
},
"RegionInfo": {
"RegionId": 0,
"Region": "ap-bhmini-ecm",
"RegionName": "腾讯滨海专区"
}
},
"CreateTime": "2020-09-27 16:13:51",
"Image": {
"SrcImage": {
"InstanceName": "",
"InstanceId": "",
"ImageOsName": "centos_test",
"ImageId": "img-test",
"ImageName": "centos",
"RegionID": 20,
"RegionName": "上海",
"ImageType": "",
"ImageDescription": "info_test",
"Region": "ap-shanghai"
},
"ImageOsName": "CentOS 7.6 64位",
"ImageId": "img-9qabwvbn",
"Platform": "CentOS",
"ImageName": "CentOS 7.6 64位",
"ImageCreateTime": "",
"ImageOwner": 0,
"ImageSource": "OFFICIAL",
"ImageType": "PUBLIC_IMAGE",
"IsSupportCloudInit": true,
"OsType": "linux",
"OsVersion": "7.6.0",
"ImageState": "NORMAL",
"ImageDescription": "CentOS 7.6 64位",
"Architecture": "x86_64",
"ImageSize": 50,
"TaskId": ""
},
"InstanceState": "RUNNING",
"Internet": {
"InstanceNetworkInfoSet": [
{
"Primary": true,
"NetworkInterfaceId": "eni-m5gnw3tv",
"NetworkInterfaceName": "ein-bb0ab3pc Primary ENI",
"AddressInfoSet": [
{
"PublicIPAddressInfo": {
"PublicIPAddress": "118.126.126.23",
"ISP": {
"ISPName": "电信",
"ISPId": "CTCC"
},
"MaxBandwidthOut": 25,
"ChargeMode": "BANDWIDTH_PACKAGE",
"MaxBandwidthIn": 0
},
"PrivateIPAddressInfo": {
"PrivateIPAddress": "10.11.12.6"
}
}
]
}
],
"PrivateIPAddressSet": [
{
"PrivateIPAddress": "10.11.12.6"
}
],
"PublicIPAddressSet": [
{
"PublicIPAddress": "118.126.126.23",
"ISP": {
"ISPName": "电信",
"ISPId": "CTCC"
},
"MaxBandwidthOut": 25,
"ChargeMode": "BANDWIDTH_PACKAGE",
"MaxBandwidthIn": 0
}
]
},
"NewFlag": 0,
"ExpireState": "NORMAL",
"PayMode": 0,
"PhysicalPosition": {
"PosId": "",
"RackId": "",
"SwitchId": ""
},
"LatestOperation": "ResetInstancesPassword"
},
{
"DataDiskSize": 0,
"RestrictState": "NORMAL",
"InstanceId": "ein-b6kee4dg",
"ISP": "CTCC",
"SecurityGroupIds": [],
"SystemDisk": {
"DeleteWithInstance": false,
"DiskType": "LOCAL_BASIC",
"DiskId": "ldisk-9tvkpn8p",
"DiskSize": 50,
"SnapshotId": ""
},
"ExpireTime": "2020-09-27 16:12:24",
"TagSet": null,
"SimpleModule": {
"ModuleId": "em-xgi6r1hk",
"ModuleName": "视频V8-cedricliu"
},
"DataDisks": null,
"LatestOperationState": "SUCCESS",
"UUID": "edf97143-b1e3-43d9-b34b-cfcf3fba1820",
"SystemDiskSize": 50,
"InstanceTypeConfig": {
"Frequency": "2.5 GHz",
"GpuModelName": null,
"InstanceType": "SN3ne.4XLARGE32",
"Vcpu": 16,
"Vgpu": null,
"InstanceFamilyConfig": {
"InstanceFamilyName": "标准型SN3ne",
"InstanceFamily": "SN3ne"
},
"InstanceFamilyTypeConfig": {
"InstanceFamilyTypeName": "标准型",
"InstanceFamilyType": "S"
},
"CpuModelName": "Intel Xeon Skylake 6133",
"Memory": 32,
"ExtInfo": ""
},
"RenewFlag": 0,
"VirtualPrivateCloud": {
"PrivateIpAddresses": [
"10.11.12.17"
],
"VpcId": "vpc-95ytv1vr",
"AsVpcGateway": false,
"SubnetId": "subnet-fua8fff8",
"Ipv6AddressCount": 0
},
"IsolatedTime": "2020-09-27 16:12:24",
"InstanceName": "jiaxuan滨海机器_勿删2",
"Position": {
"ZoneInfo": {
"ZoneId": 12000001,
"Zone": "ap-bhmini-ecm-1",
"ZoneName": "腾讯滨海专区"
},
"Country": {
"CountryName": "中国",
"CountryId": "china"
},
"Ipv6Supported": true,
"Area": {
"AreaName": "华南",
"AreaId": "china-south"
},
"Province": {
"ProvinceId": "china-south-guangdong",
"ProvinceName": "广东"
},
"City": {
"CityName": "深圳",
"CityId": "china-south-guangdong-shenzhen"
},
"RegionInfo": {
"RegionId": 0,
"Region": "ap-bhmini-ecm",
"RegionName": "腾讯滨海专区"
}
},
"CreateTime": "2020-09-27 16:12:24",
"Image": {
"SrcImage": {
"InstanceName": "",
"InstanceId": "",
"ImageOsName": "centos_test",
"ImageId": "img-test",
"ImageName": "centos",
"RegionID": 20,
"RegionName": "上海",
"ImageType": "",
"ImageDescription": "info_test",
"Region": "ap-shanghai"
},
"ImageOsName": "CentOS 7.6 64位",
"ImageId": "img-9qabwvbn",
"Platform": "CentOS",
"ImageName": "CentOS 7.6 64位",
"ImageCreateTime": "",
"ImageOwner": 0,
"ImageSource": "OFFICIAL",
"ImageType": "PUBLIC_IMAGE",
"IsSupportCloudInit": true,
"OsType": "linux",
"OsVersion": "7.6.0",
"ImageState": "NORMAL",
"ImageDescription": "CentOS 7.6 64位",
"Architecture": "x86_64",
"ImageSize": 50,
"TaskId": ""
},
"InstanceState": "RUNNING",
"Internet": {
"InstanceNetworkInfoSet": [
{
"Primary": true,
"NetworkInterfaceId": "eni-mhym6o89",
"NetworkInterfaceName": "ein-b6kee4dg Primary ENI",
"AddressInfoSet": [
{
"PublicIPAddressInfo": {
"PublicIPAddress": "118.126.126.27",
"ISP": {
"ISPName": "电信",
"ISPId": "CTCC"
},
"MaxBandwidthOut": 105,
"ChargeMode": "BANDWIDTH_PACKAGE",
"MaxBandwidthIn": 0
},
"PrivateIPAddressInfo": {
"PrivateIPAddress": "10.11.12.17"
}
}
]
}
],
"PrivateIPAddressSet": [
{
"PrivateIPAddress": "10.11.12.17"
}
],
"PublicIPAddressSet": [
{
"PublicIPAddress": "118.126.126.27",
"ISP": {
"ISPName": "电信",
"ISPId": "CTCC"
},
"MaxBandwidthOut": 105,
"ChargeMode": "BANDWIDTH_PACKAGE",
"MaxBandwidthIn": 0
}
]
},
"NewFlag": 0,
"ExpireState": "NORMAL",
"PayMode": 0,
"PhysicalPosition": {
"PosId": "",
"RackId": "",
"SwitchId": ""
},
"LatestOperation": "ResetInstancesPassword"
},
{
"DataDiskSize": 0,
"RestrictState": "NORMAL",
"InstanceId": "ein-5uhtyyps",
"ISP": "CTCC",
"SecurityGroupIds": [],
"SystemDisk": {
"DeleteWithInstance": false,
"DiskType": "LOCAL_BASIC",
"DiskId": "ldisk-0fqlcnj7",
"DiskSize": 50,
"SnapshotId": ""
},
"ExpireTime": "2020-09-27 16:12:24",
"TagSet": null,
"SimpleModule": {
"ModuleId": "em-xgi6r1hk",
"ModuleName": "视频V8-cedricliu"
},
"DataDisks": null,
"LatestOperationState": "SUCCESS",
"UUID": "e85e02fb-8efd-4728-a3d7-10cf913ed4e5",
"SystemDiskSize": 50,
"InstanceTypeConfig": {
"Frequency": "2.5 GHz",
"GpuModelName": null,
"InstanceType": "SN3ne.4XLARGE32",
"Vcpu": 16,
"Vgpu": null,
"InstanceFamilyConfig": {
"InstanceFamilyName": "标准型SN3ne",
"InstanceFamily": "SN3ne"
},
"InstanceFamilyTypeConfig": {
"InstanceFamilyTypeName": "标准型",
"InstanceFamilyType": "S"
},
"CpuModelName": "Intel Xeon Skylake 6133",
"Memory": 32,
"ExtInfo": ""
},
"RenewFlag": 0,
"VirtualPrivateCloud": {
"PrivateIpAddresses": [
"10.11.12.4"
],
"VpcId": "vpc-95ytv1vr",
"AsVpcGateway": false,
"SubnetId": "subnet-fua8fff8",
"Ipv6AddressCount": 0
},
"IsolatedTime": "2020-09-27 16:12:24",
"InstanceName": "jiaxuan滨海机器_勿删1",
"Position": {
"ZoneInfo": {
"ZoneId": 12000001,
"Zone": "ap-bhmini-ecm-1",
"ZoneName": "腾讯滨海专区"
},
"Country": {
"CountryName": "中国",
"CountryId": "china"
},
"Ipv6Supported": true,
"Area": {
"AreaName": "华南",
"AreaId": "china-south"
},
"Province": {
"ProvinceId": "china-south-guangdong",
"ProvinceName": "广东"
},
"City": {
"CityName": "深圳",
"CityId": "china-south-guangdong-shenzhen"
},
"RegionInfo": {
"RegionId": 0,
"Region": "ap-bhmini-ecm",
"RegionName": "腾讯滨海专区"
}
},
"CreateTime": "2020-09-27 16:12:24",
"Image": {
"SrcImage": {
"InstanceName": "",
"InstanceId": "",
"ImageOsName": "centos_test",
"ImageId": "img-test",
"ImageName": "centos",
"RegionID": 20,
"RegionName": "上海",
"ImageType": "",
"ImageDescription": "info_test",
"Region": "ap-shanghai"
},
"ImageOsName": "CentOS 7.6 64位",
"ImageId": "img-9qabwvbn",
"Platform": "CentOS",
"ImageName": "CentOS 7.6 64位",
"ImageCreateTime": "",
"ImageOwner": 0,
"ImageSource": "OFFICIAL",
"ImageType": "PUBLIC_IMAGE",
"IsSupportCloudInit": true,
"OsType": "linux",
"OsVersion": "7.6.0",
"ImageState": "NORMAL",
"ImageDescription": "CentOS 7.6 64位",
"Architecture": "x86_64",
"ImageSize": 50,
"TaskId": ""
},
"InstanceState": "RUNNING",
"Internet": {
"InstanceNetworkInfoSet": [
{
"Primary": true,
"NetworkInterfaceId": "eni-i7nvrvbj",
"NetworkInterfaceName": "ein-5uhtyyps Primary ENI",
"AddressInfoSet": [
{
"PublicIPAddressInfo": {
"PublicIPAddress": "118.126.126.39",
"ISP": {
"ISPName": "电信",
"ISPId": "CTCC"
},
"MaxBandwidthOut": 105,
"ChargeMode": "BANDWIDTH_PACKAGE",
"MaxBandwidthIn": 0
},
"PrivateIPAddressInfo": {
"PrivateIPAddress": "10.11.12.4"
}
}
]
}
],
"PrivateIPAddressSet": [
{
"PrivateIPAddress": "10.11.12.4"
}
],
"PublicIPAddressSet": [
{
"PublicIPAddress": "118.126.126.39",
"ISP": {
"ISPName": "电信",
"ISPId": "CTCC"
},
"MaxBandwidthOut": 105,
"ChargeMode": "BANDWIDTH_PACKAGE",
"MaxBandwidthIn": 0
}
]
},
"NewFlag": 0,
"ExpireState": "NORMAL",
"PayMode": 0,
"PhysicalPosition": {
"PosId": "",
"RackId": "",
"SwitchId": ""
},
"LatestOperation": "ResetInstancesPassword"
}
],
"TotalCount": 3
}
}示例3 按照创建时间倒序查询最近的两个实例
输入示例
POST / HTTP/1.1
Host: ecm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeInstances
<公共请求参数>
{
"Limit": 2,
"OrderByField": "timestamp",
"OrderDirection": 0
}输出示例
{
"Response": {
"RequestId": "",
"InstanceSet": [
{
"DataDiskSize": 0,
"RestrictState": "NORMAL",
"InstanceId": "ein-bb0ab3pc",
"ISP": "CTCC",
"SecurityGroupIds": [],
"SystemDisk": {
"DeleteWithInstance": false,
"DiskType": "LOCAL_BASIC",
"DiskId": "ldisk-91p8tj1p",
"DiskSize": 50,
"SnapshotId": ""
},
"ExpireTime": "2020-09-27 16:13:51",
"TagSet": null,
"SimpleModule": {
"ModuleId": "em-5wrpefy1",
"ModuleName": "jiaxuan"
},
"DataDisks": null,
"LatestOperationState": "SUCCESS",
"UUID": "3c3e605a-33a0-41ca-9251-5f115a531c3e",
"SystemDiskSize": 50,
"InstanceTypeConfig": {
"Frequency": "2.5 GHz",
"GpuModelName": null,
"InstanceType": "SN3ne.2XLARGE16",
"Vcpu": 8,
"Vgpu": null,
"InstanceFamilyConfig": {
"InstanceFamilyName": "标准型SN3ne",
"InstanceFamily": "SN3ne"
},
"InstanceFamilyTypeConfig": {
"InstanceFamilyTypeName": "标准型",
"InstanceFamilyType": "S"
},
"CpuModelName": "Intel Xeon Skylake 6133",
"Memory": 16,
"ExtInfo": ""
},
"RenewFlag": 0,
"VirtualPrivateCloud": {
"PrivateIpAddresses": [
"10.11.12.6"
],
"VpcId": "vpc-95ytv1vr",
"AsVpcGateway": false,
"SubnetId": "subnet-fua8fff8",
"Ipv6AddressCount": 0
},
"IsolatedTime": "2020-09-27 16:13:51",
"InstanceName": "jiaxuan滨海_勿删2",
"Position": {
"ZoneInfo": {
"ZoneId": 12000001,
"Zone": "ap-bhmini-ecm-1",
"ZoneName": "腾讯滨海专区"
},
"Country": {
"CountryName": "中国",
"CountryId": "china"
},
"Ipv6Supported": true,
"Area": {
"AreaName": "华南",
"AreaId": "china-south"
},
"Province": {
"ProvinceId": "china-south-guangdong",
"ProvinceName": "广东"
},
"City": {
"CityName": "深圳",
"CityId": "china-south-guangdong-shenzhen"
},
"RegionInfo": {
"RegionId": 0,
"Region": "ap-bhmini-ecm",
"RegionName": "腾讯滨海专区"
}
},
"CreateTime": "2020-09-27 16:13:51",
"Image": {
"SrcImage": {
"InstanceName": "",
"InstanceId": "",
"ImageOsName": "centos_test",
"ImageId": "img-test",
"ImageName": "centos",
"RegionID": 20,
"RegionName": "上海",
"ImageType": "",
"ImageDescription": "info_test",
"Region": "ap-shanghai"
},
"ImageOsName": "CentOS 7.6 64位",
"ImageId": "img-9qabwvbn",
"Platform": "CentOS",
"ImageName": "CentOS 7.6 64位",
"ImageCreateTime": "",
"ImageOwner": 0,
"ImageSource": "OFFICIAL",
"ImageType": "PUBLIC_IMAGE",
"IsSupportCloudInit": true,
"OsType": "linux",
"OsVersion": "7.6.0",
"ImageState": "NORMAL",
"ImageDescription": "CentOS 7.6 64位",
"Architecture": "x86_64",
"ImageSize": 50,
"TaskId": ""
},
"InstanceState": "RUNNING",
"Internet": {
"InstanceNetworkInfoSet": [
{
"Primary": true,
"NetworkInterfaceId": "eni-m5gnw3tv",
"NetworkInterfaceName": "ein-bb0ab3pc Primary ENI",
"AddressInfoSet": [
{
"PublicIPAddressInfo": {
"PublicIPAddress": "118.126.126.23",
"ISP": {
"ISPName": "电信",
"ISPId": "CTCC"
},
"MaxBandwidthOut": 25,
"ChargeMode": "BANDWIDTH_PACKAGE",
"MaxBandwidthIn": 0
},
"PrivateIPAddressInfo": {
"PrivateIPAddress": "10.11.12.6"
}
}
]
}
],
"PrivateIPAddressSet": [
{
"PrivateIPAddress": "10.11.12.6"
}
],
"PublicIPAddressSet": [
{
"PublicIPAddress": "118.126.126.23",
"ISP": {
"ISPName": "电信",
"ISPId": "CTCC"
},
"MaxBandwidthOut": 25,
"ChargeMode": "BANDWIDTH_PACKAGE",
"MaxBandwidthIn": 0
}
]
},
"NewFlag": 0,
"ExpireState": "NORMAL",
"PayMode": 0,
"PhysicalPosition": {
"PosId": "",
"RackId": "",
"SwitchId": ""
},
"LatestOperation": "ResetInstancesPassword"
},
{
"DataDiskSize": 0,
"RestrictState": "NORMAL",
"InstanceId": "ein-b6kee4dg",
"ISP": "CTCC",
"SecurityGroupIds": [],
"SystemDisk": {
"DeleteWithInstance": false,
"DiskType": "LOCAL_BASIC",
"DiskId": "ldisk-9tvkpn8p",
"DiskSize": 50,
"SnapshotId": ""
},
"ExpireTime": "2020-09-27 16:12:24",
"TagSet": null,
"SimpleModule": {
"ModuleId": "em-xgi6r1hk",
"ModuleName": "视频V8-cedricliu"
},
"DataDisks": null,
"LatestOperationState": "SUCCESS",
"UUID": "edf97143-b1e3-43d9-b34b-cfcf3fba1820",
"SystemDiskSize": 50,
"InstanceTypeConfig": {
"Frequency": "2.5 GHz",
"GpuModelName": null,
"InstanceType": "SN3ne.4XLARGE32",
"Vcpu": 16,
"Vgpu": null,
"InstanceFamilyConfig": {
"InstanceFamilyName": "标准型SN3ne",
"InstanceFamily": "SN3ne"
},
"InstanceFamilyTypeConfig": {
"InstanceFamilyTypeName": "标准型",
"InstanceFamilyType": "S"
},
"CpuModelName": "Intel Xeon Skylake 6133",
"Memory": 32,
"ExtInfo": ""
},
"RenewFlag": 0,
"VirtualPrivateCloud": {
"PrivateIpAddresses": [
"10.11.12.17"
],
"VpcId": "vpc-95ytv1vr",
"AsVpcGateway": false,
"SubnetId": "subnet-fua8fff8",
"Ipv6AddressCount": 0
},
"IsolatedTime": "2020-09-27 16:12:24",
"InstanceName": "jiaxuan滨海机器_勿删2",
"Position": {
"ZoneInfo": {
"ZoneId": 12000001,
"Zone": "ap-bhmini-ecm-1",
"ZoneName": "腾讯滨海专区"
},
"Country": {
"CountryName": "中国",
"CountryId": "china"
},
"Ipv6Supported": true,
"Area": {
"AreaName": "华南",
"AreaId": "china-south"
},
"Province": {
"ProvinceId": "china-south-guangdong",
"ProvinceName": "广东"
},
"City": {
"CityName": "深圳",
"CityId": "china-south-guangdong-shenzhen"
},
"RegionInfo": {
"RegionId": 0,
"Region": "ap-bhmini-ecm",
"RegionName": "腾讯滨海专区"
}
},
"CreateTime": "2020-09-27 16:12:24",
"Image": {
"SrcImage": {
"InstanceName": "",
"InstanceId": "",
"ImageOsName": "centos_test",
"ImageId": "img-test",
"ImageName": "centos",
"RegionID": 20,
"RegionName": "上海",
"ImageType": "",
"ImageDescription": "info_test",
"Region": "ap-shanghai"
},
"ImageOsName": "CentOS 7.6 64位",
"ImageId": "img-9qabwvbn",
"Platform": "CentOS",
"ImageName": "CentOS 7.6 64位",
"ImageCreateTime": "",
"ImageOwner": 0,
"ImageSource": "OFFICIAL",
"ImageType": "PUBLIC_IMAGE",
"IsSupportCloudInit": true,
"OsType": "linux",
"OsVersion": "7.6.0",
"ImageState": "NORMAL",
"ImageDescription": "CentOS 7.6 64位",
"Architecture": "x86_64",
"ImageSize": 50,
"TaskId": ""
},
"InstanceState": "RUNNING",
"Internet": {
"InstanceNetworkInfoSet": [
{
"Primary": true,
"NetworkInterfaceId": "eni-mhym6o89",
"NetworkInterfaceName": "ein-b6kee4dg Primary ENI",
"AddressInfoSet": [
{
"PublicIPAddressInfo": {
"PublicIPAddress": "118.126.126.27",
"ISP": {
"ISPName": "电信",
"ISPId": "CTCC"
},
"MaxBandwidthOut": 105,
"ChargeMode": "BANDWIDTH_PACKAGE",
"MaxBandwidthIn": 0
},
"PrivateIPAddressInfo": {
"PrivateIPAddress": "10.11.12.17"
}
}
]
}
],
"PrivateIPAddressSet": [
{
"PrivateIPAddress": "10.11.12.17"
}
],
"PublicIPAddressSet": [
{
"PublicIPAddress": "118.126.126.27",
"ISP": {
"ISPName": "电信",
"ISPId": "CTCC"
},
"MaxBandwidthOut": 105,
"ChargeMode": "BANDWIDTH_PACKAGE",
"MaxBandwidthIn": 0
}
]
},
"NewFlag": 0,
"ExpireState": "NORMAL",
"PayMode": 0,
"PhysicalPosition": {
"PosId": "",
"RackId": "",
"SwitchId": ""
},
"LatestOperation": "ResetInstancesPassword"
}
],
"TotalCount": 15
}
}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
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure.UnauthorizedOperation | 鉴权失败。 |
| FailedOperation.InternalOperationFailure | 内部操作错误。 |
| InvalidParameter.InvalidDataFormat | 数据格式不正确。 |
| InvalidParameterValue.InvaildDescribeInstance | 您的输入有误或无相应的操作权限。 |
| InvalidParameterValue.InvaildPageParam | 分页参数不合法。 |
| InvalidParameterValue.InvalidFilter | 无效过滤器。 |
| InvalidParameterValue.InvalidInstanceID | 实例ID不合法。 |
| InvalidParameterValue.InvalidOrderByField | 排序字段不合法。 |
| InvalidParameterValue.ParameterValueTooLarge | 参数值超出限制。 |
| ResourceNotFound.InstanceNotExist | 实例不合法。 |
| UnauthorizedOperation.ForbiddenOperation | 没有权限进行该操作。 |