GET https://cvm.api.qcloud.com/v2/index.php? (1)
Action=DescribeInstances
&SecretId=xxxxxxx
&Region=ap-guangzhou
&Timestamp=1465055529 (2)
&Nonce=59485
&Signature=mysignature
&SignatureMethod=HmacSHA256
&InstanceIds.0=ins-0hm4gvho (3)
本文档一共具有三个版本:
团队内版本
公司内部开发者版本
公开版本
这份版本是团队内版本,也信息是信息最丰富的版本。存在部分敏感内容,注意保密。
欢迎使用云服务器(Cloud Virtual Machine)。
腾讯云服务器(Cloud Virtual Machine,以下又称CVM)运行在腾讯数据中心,它提供了可以弹性伸缩的计算服务,可以根据业务需要来构建和托管软件系统。
云服务器向用户提供弹性的计算、存储和网络资源。用户可以使用本文档介绍的 API,并参照相应的示例,对云服务器进行相关操作:如创建、销毁、更改带宽、重启等;支持的全部操作可参见 Actions,具体使用与调用方式可参见使用方式
本文档涉及的一些常用术语如下:
弹性IP是公网IP的一种。与普通公网IP不同的是,弹性IP归属于用户账户而不是实例;实例与公网IP的映射关系随时可以更改。
Permanent storage for operating system and/or user files. Image: [镜像](https://cloud.tencent.com/doc/product/213/4940). CVM实例上软件环境的拷贝,一般包括操作系统和已安装的软件;我们使用镜像来创建实例。
可用区 指腾讯云在同一https://cloud.tencent.com/doc/product/213/6091[地域]内电力和网络互相独立的物理数据中心。目标是能够保证可用区之间故障相互隔离,不出现故障扩散,使得用户的业务持续在线服务。
安全组是一种有状态的包过滤功能的虚拟防火墙,用于控制CVM实例的网络访问, 是一种重要的网络安全隔离手段。 包年包月::一种计费模式,参看https://cloud.tencent.com/doc/product/213/2180#1.-.E5.8C.85.E5.B9.B4.E5.8C.85.E6.9C.88[计费模式说明]。 按量计费::一种计费模式,参看https://cloud.tencent.com/doc/product/213/2180#2.-.E6.8C.89.E9.87.8F.E8.AE.A1.E8.B4.B9[计费模式说明]。
该参数用来控制返回结果分页;当返回结果过多时,如果数量超过了 Limit 所限定的值,那么只会返回Limit个值。此时用户可以通过增大Offset 参数来获取那些被截断了的结果;或者增加 Limit(单次返回的最大条目数量)的值也可以达到相同的效果。 举例来说,参数 Offset=0&Limit=20 返回第0到20项,Offset=20&Limit=20 返回第20到40项,Offset=40&Limit=20 返回第40到60项;以此类推。
可同时输入多个参数。当遇到形如这样的格式时,那么意味着该参数可以同时传多个。例如: Ids.0=10.12.243.21&Ids.1=10.11.243.21&Ids.2=10.12.243.21&Id.3=10.13.243.21
请注意,下标0开始。
CVM API的使用方式这里针对几个典型的使用场景来说明:
CVM API 调用配额为:1000次/分钟;且单一API不超过100次/分钟。
API创建的机器遵循 CVM实例购买限制 文档所描述的数量限制,和官网所创建的机器共用配额。
更具体的限制请参考每个API接口文档或是产品文档。
调用 API ,实际上就是是对一个指定的 URL 进行 GET 请求
其中请求 URL 由以下几部分组成:
域名: 实际的请求域名根据 Action 实际所属的模块而各异, 以 DescribeInstances
为例,其请求域名为:cvm.api.qcloud.com
路径: 目前,云API的请求路径固定为 /v2/index.php
请求参数串: 包括公共参数和接口参数,注意:一旦缺失公共参数,请求将无法被 Action 处理。
最终的请求 URL 的拼接规则为:
https:// + 请求域名 + 请求路径 + ? + 请求参数串(包括公共参数和接口参数)
假设用户想要查询广州地域的云服务器实例列表,则其请求链接的形式可能如下:
GET https://cvm.api.qcloud.com/v2/index.php? (1)
Action=DescribeInstances
&SecretId=xxxxxxx
&Region=ap-guangzhou
&Timestamp=1465055529 (2)
&Nonce=59485
&Signature=mysignature
&SignatureMethod=HmacSHA256
&InstanceIds.0=ins-0hm4gvho (3)
请求域名
公共参数
接口参数
公共请求参数是每个接口都需要使用到的请求参数,如非必要, 在各个接口单独的文档中不再对这些参数进行说明, 但每次请求均需要携带这些参数, 才能正常发起请求。
参数名称 |
是否必选 |
描述 |
Action |
是 |
具体操作的指令接口名称,例如想要调用查询实例列表接口,则 Action 参数即为 DescribeInstances。 |
Region |
否 |
区域参数,用来标识希望操作哪个区域的实例 * 正常情况下此参数是必须的,如无需传入,则会在相应接口中进行特殊说明 * 某些区域仅面向部分用户开放 |
Timestamp |
是 |
当前UNIX时间戳,可记录发起 API 请求的时间。 |
Nonce |
是 |
随机正整数,与 Timestamp 联合起来, 用于防止重放攻击。 |
SecretId |
是 |
在云API密钥上申请的标识身份的 SecretId,一个 SecretId 对应唯一的 SecretKey , 而 SecretKey 会用来生成请求签名 Signature。具体可参考 签名方法 页面。 |
Signature |
是 |
请求签名,用来验证此次请求的合法性,需要用户根据实际的输入参数计算得出。计算方法可参考 此处。 |
SignatureMethod |
否 |
签名方式,目前支持 SHA256和 SHA1。只有指定此参数为 SHA256 时,才使用 SHA256 算法验证签名,其他情况均使用 SHA1 验证签名。当前建议您使用 SHA256,具体签名计算方法可参考 签名方法 页面。 |
Token |
否 |
临时证书所用的 Token,需要结合临时密钥一起使用。长期密钥不需要 Token。 |
{
"Response": { (1)
"InstanceSet": [ (2)
"ins-a19qoqqk"
],
"RequestId": "22471ac8-24a1-4653-af32-e375fb64ab58" (3)
}
}
Response 的出现代表着腾讯云收到了一个正常请求,正在处理或者已经被处理。
典型的数据字段,它被每个 Action 所自定义,其内容根据每个 Action 的不同而所有出入。
RequestId 用于一个 API 请求的唯一标识,如果 API 出现异常,可以联系我们,并提供该 ID 来解决问题。
{
"Error": { (1)
"Code": "InvalidParameterCombination", (2)
"Message": "The combination of parameters between InstanceType and .SystemDisk.DiskType in incorrect" (3)
},
"RequestId": "edc94b6d-9416-45b6-8cd2-ced02e6cf2ec" (4)
}
Error 的出现代表着腾讯云无法处理这个请求。
Code 标识了这个错误的大体原因,可能描述的并不明确,但是不会经常发生变更。
Message 显示出了这个错误发生的具体原因,随着业务发展或体验优化,此文本可能会经常保持变更或更新,您不应依赖这个返回值。
RequestId 用于一个 API 请求的唯一标识,如果 API 出现异常,可以联系我们,并提供该 ID 来解决问题。
CVM API 对于腾讯云内部业务方单独提供一个调用方式,无需通过API鉴权。
具体调用方式为:
curl -d '{}' http://server:8520/
返回包的形式为标准JSON,亦完全符合本文档中的 API 返回值定义。
每个地域均可访问到 cvmapiv3.tencentyun.com
如需跨地域调用,可以通过下列域名:
bj.cvmapiv3.tencentyun.com
sh.cvmapiv3.tencentyun.com
gz.cvmapiv3.tencentyun.com
shjr.cvmapiv3.tencentyun.com
szjr.cvmapiv3.tencentyun.com
gzopen.cvmapiv3.tencentyun.com
ca.cvmapiv3.tencentyun.com
hk.cvmapiv3.tencentyun.com
sg.cvmapiv3.tencentyun.com
usw.cvmapiv3.tencentyun.com
相关IP可参见: PKG包管理中各地域机房的IP。
本项目基于以下开源项目或标准构建,可以在时间允许的情况下,更多的了解下面的技术。
CPython 3.6 (Python语言的解释器)
Gevent(一种基于libevent事件循环的协程实现) 每次time.sleep 或者 socket.recv 等操作时,隐含了yeild 语义。
uWSGI(一个比较完善的易于运维的容器)
CBOR:the general-purpose schema-less binary data format
也就是说,CBOR可以看成是json的一个二进制版本,非人类可读,但是在各种基准测试中比json实现要快10倍。而且占用空间小。相比于protobuf,cbor不用预先 定义二进制的struct。与json一样自由。
TOML:是ini的一个超集。我们将其用作MASTER的标准配置文件格式。
不同于ini没有一个协议标准,TOML是Github所定义的具有严格标准且同json等价的格式。也就是说toml可以表达json能表达的全部内容,而对人类更加友好。避>免了使用不同解析器对相同ini的不同解读的同时,也获得了更丰富的表达形式。同SPP使用的yaml相比,可读性更好,移植性也更好。
为了帮助用户快速使用云服务器(CVM)API,这里给出一个使用示例,它能够引导您使用API服务完整的创建并销毁一个实例。
在创建实例前,我们首先需要确定其配置,因为它决定了用户所创建实例的性能。
平台支持的有关配置,用户可以参考https://cloud.tencent.com/doc/product/213/497#3.-.E6.9C.BA.E5.9E.8B[CVM实例机型] 和 CVM实例配置。
假设我们想创建一个新的广州二区的 Windows 2008 操作系统的实例,所需要需要的最小请求参数是:
参数名称 | 描述 | 取值 |
---|---|---|
Zone |
可用区ID |
ap-guangzhou-2 |
ImageId |
镜像ID |
img-lkxqa4kj |
InternetAccessible.InternetMaxBandwidthOut |
公网带宽值 |
1 |
未在参数中指明的则使用默认值;
默认的标准机型:S1.SMALL1
密码将会自动生成,并通过站内信的形式下发。
这里我们指定的镜像为 Windows 2008,其它标准操作系统的 ImageId 可见https://cloud.tencent.com/doc/api/229/1272[镜像列表]
也可以修改这些默认值以便修改根据您的需要来创建实例,这一点可以详细参考 RunInstances,它详尽的列出了每个可能的参数。
除了两个请求之外,还需要增加公共请求参数,最终得到的请求形式如下:
GET https://cvm.api.qcloud.com/v2/index.php?
&Action=RunInstances
&Version=2017-03-20
&ImageId=img-lkxqa4kj
&Zone=ap-guangzhou-2
&Region=ap-guangzhou
&Nonce=7000
&SecretId=AKIDxxxxugSKIP
&Signature=5umi9gUWpTTyk18V2g%2FYi56hqls%3D
上述请求的返回结果如下
{
"Response": {
"InstanceSet": [
"ins-a19qoqqk"
],
"RequestId": "22471ac8-24a1-4653-af32-e375fb64ab58"
}
}
由结果可知,新创建的实例的ID是 ins-a19qoqqk
。这个ID唯一标识了这个实例。后续将实例进行退还操作或是调整配置都需要通过它来指定对象。
当拥有了一个实例ID时,我们可以使用 DescribeInstances
查询这个实例的相关信息。
GET https://cvm.api.qcloud.com/v2/index.php?
&Action=DescribeInstances
&Version=2017-03-20
&InstanceIds.0=ins-a19qoqqk
&Region=ap-guangzhou
&Nonce=7000
&SecretId=AKIDxxxxugSKIP
&Signature=5umi9gUWpTTyk18V2g%2FYi56hqls%3D
{
"Response": {
"TotalCount": 1,
"InstanceSet": [
{
"Placement": {
"Zone": "ap-guangzhou-2",
"HostId": null,
"ProjectId": 0
},
"InstanceId": "ins-a19qoqqk",
"InstanceType": "S1.SMALL1",
"CPU": 1,
"Memory": 1,
"InstanceName": "未命名",
"InstanceChargeType": "POSTPAID_BY_HOUR",
"DataDisks": [],
"PrivateIpAddresses": [
"172.16.0.140"
],
"PublicIpAddresses": [
"139.199.232.98"
],
"InternetAccessible": {
"InternetMaxBandwidthOut": 0,
"InternetChargeType": "BANDWIDTH_POSTPAID_BY_HOUR"
},
"VirtualPrivateCloud": {
"VpcId": "vpc-8xug6adl",
"SubnetId": "subnet-4c7w5wii",
"AsVpcGateway": false
},
"ImageId": "img-lkxqa4kj",
"RenewFlag": null,
"CreatedTime": "2017-05-25T08:50:23Z",
"ExpiredTime": null,
}
],
"RequestId": "22471ac8-24a1-4653-af32-e375fb64ab58"
}
}
从`DescirbeInstances`的返回包(上述)中找到 Response.InstanceSet.0.PublicIpAddresses
字段,该字段为您实例的公网IP。在Windows 中搜索”远程桌面"功能并运行,输入IP,账户名以及密码即可登录实例。
Windows 默认账户名为 Administrator。
密码是您创建实例时指定的值,没有指定的话将会通过站内信下发给您。
由于按量计费类型的实例会实时计费,不需要的时候我们可以主动退还它。 具体的接口请求参数见下表:
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
InstanceId |
是 |
String |
实例ID |
结合公共请求参数和接口请求参数,最终得到的请求形式如下:
https://cvm.api.qcloud.com/v2/index.php?
&Action=TerminateInstances
&Version=2017-03-20
&InstanceIds.0=ins-a19qoqqk
&Region=ap-guangzhou
&Timestamp=1465750149
&Nonce=46364
&SecretId=AKIDxxxxugEY
&Signature=5umi9gUWpTTyk18V2g%2FYi56hqls%3D
{
"Response": {
"RequestId": "22471ac8-24a1-4653-af32-e375fb64ab58"
}
}
如果没有异常,则证明退还成功。
描述了实例的抽象位置,包括其所在的可用区,所属的项目,宿主机等(仅CDH产品可用)
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
DiskType |
String |
否 |
系统盘类型。 |
Zone |
String |
是 |
实例所属的可用区ID。该参数可以通过调用 [DescribeZones](https://cloud.tencent.com/document/api/213/9455)的返回值中的Zone字段来获取。 |
ProjectId |
Integer |
否 |
实例所属项目ID。该参数可以通过调用 [DescribeProject](https://cloud.tencent.com/document/api/378/4400)的返回值中的 projectId 字段来获取。不填为默认项目。 |
HostIds.N |
array of Strings |
否 |
实例所属的专用宿主机ID列表。如果您有购买专用宿主机并且指定了该参数,则您购买的实例就会随机的部署在这些专用宿主机上。当前暂不支持。 |
描述了操作系统所在块设备即系统盘的信息
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
DiskType |
String |
否 |
系统盘类型。 系统盘类型限制详见CVM实例配置。取值范围:
|
DiskId |
String |
否 |
系统盘ID。LOCAL_BASIC 和 LOCAL_SSD 类型没有ID。暂时不支持该参数。 |
DiskSize |
Integer |
否 |
"系统盘大小,单位:GB。 若不指定该参数,则默认为50GB。" |
描述了数据盘的信息
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
DiskType |
String |
否 |
数据盘类型。数据盘类型限制详见[CVM实例配置](https://cloud.tencent.com/document/product/213/2177)。取值范围:
|
DiskId |
String |
否 |
系统盘ID。LOCAL_BASIC 和 LOCAL_SSD 类型没有ID。暂时不支持该参数。 |
DiskSize |
Integer |
是 |
数据盘大小,单位:GB。最小调整步长为10G,不同数据盘类型取值范围不同,可参考具体限制。默认值为0,表示不购买数据盘。 |
描述了VPC相关信息,包括子网,IP信息等
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
VpcId |
String |
是 |
私有网络ID。该参数可以通过调用https://cloud.tencent.com/document/api/215/1372[DescribeVpcEx]的返回值中的unVpcId字段来获取。 |
SubnetId |
String |
是 |
私有网络子网ID。该参数可以通过调用https://cloud.tencent.com/document/api/215/1371[DescribeSubnetEx]的返回值中的unSubnetId字段来获取。 |
AsVpcGateway |
Boolean |
否 |
是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围: TRUE:表示用作公网网关 FALSE:表示不用作公网网关默认取值:FALSE。 |
PrivateIpAddresses.N |
array of Strings |
否 |
描述了实例的公网可访问性,声明了实例的公网使用计费模式,最大带宽等
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
InternetChargeType |
String |
否 |
网络计费类型。取值范围: BANDWIDTH_PREPAID:预付费按带宽结算 TRAFFIC_POSTPAID_BY_HOUR:流量按小时后付费 BANDWIDTH_POSTPAID_BY_HOUR:带宽按小时后付费 |
描述了实例的计费模式
名称 |
类型 |
是否必选 |
描述 |
Period |
Integer |
是 |
购买实例的时长,单位:月。 取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。 |
Period |
Integer |
是 |
购买实例的时长,单位:月。 取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。 |
RenewFlag |
String |
否 |
自动续费标识。取值范围: NOTIFY_AND_AUTO_RENEW:通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费默认取值:NOTIFY_AND_AUTO_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。 |
描述了实例登录相关配置与信息。
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Password |
String |
否 |
实例登录密码。不同操作系统类型密码复杂度限制不一样,具体如下: Linux实例密码必须8到16位,至少包括两项[a-z,A-Z]、[0-9] 和 [( ) ` ~ ! @ # $ % ^ & * - + = | \{ } [ ] : ; ' , . ? / ]中的特殊符号。 Windows实例密码必须12到16位,至少包括三项[a-z],[A-Z],[0-9] 和 [( ) ` ~ ! @ # $ % ^ & * - + = \{ } [ ] : ; ' , . ? /]中的特殊符号。若不指定该参数,则由系统随机生成密码,并通过站内信方式通知到用户。 |
KeyIds.N |
array of Strings |
否 |
密钥ID列表。关联密钥后,就可以通过对应的私钥来访问实例;KeyId可通过接口DescribeKeyPairs获取,密钥与密码不能同时指定,同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。 |
KeepImageLogin |
String |
否 |
描述了 “云安全” 服务相关的信息
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Enabled |
Boolean |
否 |
是否开启https://cloud.tencent.com/document/product/296[云安全]服务。取值范围: TRUE:表示开启云安全服务 FALSE:表示不开启云安全服务默认取值:TRUE。 |
描述了 “云监控” 服务相关的信息
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Enabled |
Boolean |
否 |
是否开启https://cloud.tencent.com/document/product/248[云监控]服务。取值范围: TRUE:表示开启云监控服务 FALSE:表示不开启云监控服务默认取值:TRUE。 |
描述了实例的增强服务启用情况与其设置,如云安全,云监控等实例 Agent
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
SecurityService |
否 |
开启云安全服务。若不指定该参数,则默认开启云安全服务。 |
|
MonitorService |
否 |
开启云安全服务。若不指定该参数,则默认开启云监控服务。 |
描述了单项的价格信息
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
UnitPrice |
Integer |
否 |
后续单价,单位:元。 |
ChargeUnit |
String |
否 |
后续计价单元,可取值范围: HOUR:表示计价单元是按每小时来计算。当前涉及该计价单元的场景有:实例按小时后付费(POSTPAID_BY_HOUR)、带宽按小时后付费(BANDWIDTH_POSTPAID_BY_HOUR): GB:表示计价单元是按每GB来计算。当前涉及该计价单元的场景有:流量按小时后付费(TRAFFIC_POSTPAID_BY_HOUR)。 |
OriginalPrice |
Integer |
否 |
|
预支费用的原价,单位:元。 |
DiscountPrice |
Integer |
价格
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
InstancePrice |
ItemPrice object |
否 |
描述了实例价格。 |
BandwidthPrice |
ItemPrice object |
否 |
描述了网络价格。 |
描述键值对过滤器,用于条件过滤查询。例如过滤ID、名称、状态等
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Name |
String |
否 |
过滤键的名称。 |
Values.N |
array of Strings |
否 |
一个或者多个过滤值。 |
描述实例的状态。状态类型详见link:[实例状态表]
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
InstanceId |
String |
否 |
实例`ID`。 |
InstanceState |
String |
否 |
link:[实例状态]。 |
描述实例的信息
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Placement |
否 |
实例所在的位置。 |
|
InstanceId |
String |
否 |
实例`ID`。 |
InstanceType |
String |
否 |
实例机型。 |
CPU |
Integer |
否 |
实例的CPU核数,单位:核。 |
Memory |
Integer |
否 |
实例内存容量,单位: |
InstanceName |
String |
否 |
实例名称。 |
InstanceChargeType |
String |
否 |
实例计费模式。取值范围:
|
SystemDisk |
否 |
实例系统盘信息。 |
|
DataDisks |
array of DataDisk |
否 |
实例数据盘信息。只包含随实例购买的数据盘。 |
PrivateIpAddresses |
array of Strings |
否 |
实例主网卡的内网`IP`列表。 |
PublicIpAddresses |
array of Strings |
否 |
实例主网卡的公网`IP`列表。 |
InternetAccessible |
否 |
实例带宽信息。 |
|
VirtualPrivateCloud |
否 |
实例所属虚拟私有网络信息。 |
|
ImageId |
String |
否 |
生产实例所使用的镜像`ID`。 |
AutoRenew |
String |
否 |
自动续费标识。取值范围:
|
CreatedTime |
Timestamp |
否 |
|
创建时间。按照`ISO8601`标准表示,并且使用`UTC`时间。格式为: |
ExpiredTime |
Timestamp |
否 |
描述实例机型配置信息
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
Zone |
String |
否 |
|
InstanceType |
String |
否 |
实例机型。 |
InstanceFamily |
String |
否 |
实例机型系列。 |
GPU |
Integer |
否 |
GPU核数,单位:核。 |
CPU |
Integer |
否 |
CPU核数,单位:核。 |
Memory |
Integer |
否 |
内存容量,单位: |
CbsSupport |
String |
否 |
是否支持云硬盘。取值范围:
|
InstanceTypeState |
String |
否 |
描述了指定的账号能够使用该共享镜像
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
ImageId |
String |
否 |
镜像ID |
AccountId |
String |
否 |
账户ID |
描述了配额信息
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
QuotaName |
String |
否 |
配额名称 |
QuotaCurrent |
Integer |
否 |
当前数量 |
QuotaLimit |
Integer |
否 |
配额数量 |
描述了一个镜像
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
ImageId |
String |
否 |
镜像ID |
OsName |
String |
否 |
操作系统名称 |
ImageSize |
String |
否 |
操作系统容量(GiB) |
ImageType |
Integer |
否 |
镜像类型 |
CreatedTime |
String |
否 |
创建时间 |
ImageState |
String |
否 |
镜像状态 |
ImageName |
String |
否 |
镜像名称 |
ImageDescription |
String |
否 |
镜像详细描述 |
ImageSource |
String |
否 |
镜像来源。 |
ImageCreator |
String |
否 |
镜像创建者 |
描述可用区信息。
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
RegionId |
String |
否 |
地域ID。 |
Zone |
String |
否 |
可用区ID。 |
ZoneName |
String |
否 |
可用区名称。 |
ZoneState |
String |
否 |
可用区状态。 |
描述密钥对信息
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
KeyId |
String |
否 |
密钥对的`ID`,是密钥对的唯一标识。 |
KeyName |
String |
否 |
密钥对名称。 |
ProjectId |
String |
否 |
密钥对所属的项目`ID`。 |
Description |
String |
否 |
密钥对描述信息。 |
PublicKey |
String |
否 |
密钥对的纯文本公钥。 |
PrivateKey |
String |
否 |
密钥对的纯文本私钥。腾讯云不会保管私钥,请用户自行妥善保存。 |
AssociatedInstanceIds |
array of Strings |
否 |
密钥关联的实例`ID`列表。 |
CreatedTime |
Timestamp |
否 |
创建时间。按照`ISO8601`标准表示,并且使用`UTC`时间。格式为: |
描述密钥对和实例的关联关系
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
KeyId |
String |
否 |
密钥对的`ID`,是密钥对的唯一标识。 |
AssociatedInstanceIdSet |
array of Strings |
否 |
密钥对关联的实例`ID`列表。 |
描述 EIP 信息
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
AddressId |
String |
否 |
|
AddressName |
String |
否 |
`EIP`名称。 |
AddressState |
String |
否 |
`EIP`状态。 |
AddressIp |
String |
否 |
弹性外网IP |
BindedResourceId |
String |
否 |
绑定的资源实例`ID`。可能是一个`CVM`, |
CreatedTime |
Timestamp |
否 |
创建时间。按照`ISO8601`标准表示,并且使用`UTC`时间。格式为: |
描述了实例计费
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
InstanceChargeType |
String |
否 |
实例计费模式。 |
Description |
String |
否 |
实例计费模式描述信息。 |
描述了网络计费
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
InternetChargeType |
String |
否 |
网络计费模式。 |
Description |
String |
否 |
网络计费模式描述信息。 |
描述了按带宽计费的相关信息
名称 | 类型 | 是否必选 | 描述 |
---|---|---|---|
StartTime |
Timestamp |
否 |
开始时间。按照`ISO8601`标准表示,并且使用`UTC`时间。格式为: |
EndTime |
Timestamp |
否 |
结束时间。按照`ISO8601`标准表示,并且使用`UTC`时间。格式为: |
InternetAccessible |
否 |
实例带宽信息。 |
描述了一个实例的整个生命周期。
ID | 描述 |
---|---|
PENDING |
准备中 |
RUNNING |
运行中 |
STOPPED |
已停止 |
REBOOTING |
重启中 |
STARTING |
启动中 |
STOPPING |
停止中 |
EXPIRED |
已过期 |
TERMINATING |
退还中 |
TERMINATED |
已退还 |
地域表
ID | 描述 |
---|---|
ap-guangzhou |
广州 |
ap-shanghai |
上海 |
ap-hongkong |
香港 |
na-toronto |
北美 |
ap-shanghai-fsi |
上海金融 |
ap-beijing |
北京 |
ap-singapore |
新加坡 |
ap-shenzhen-fsi |
深圳金融 |
ap-guangzhou-open |
广州Open |
描述了地域下属的可用区
ID | 描述 |
---|---|
ap-guangzhou-1 |
广州一区 |
ap-guangzhou-2 |
广州二区 |
ap-guangzhou-3 |
广州三区 |
ap-shanghai-1 |
上海一区 |
ap-shanghai-2 |
上海二区 |
ap-hongkong-1 |
香港一区 |
na-toronto-1 |
北美一区 |
ap-shanghai-fsi-1 |
上海金融一区 |
ap-shanghai-fsi-2 |
上海金融二区 |
ap-beijing-1 |
北京一区 |
ap-beijing-2 |
北京二区 |
ap-singapore-1 |
新加坡一区 |
ap-shenzhen-fsi-1 |
深圳金融一区 |
ap-shenzhen-fsi-2 |
深圳金融二区 |
ap-guangzhou-open-1 |
广州Open专区 |
磁盘类型
ID | 描述 |
---|---|
LOCAL_BASIC |
普通本地盘 |
LOCAL_SSD |
SSD本地盘 |
CLOUD_BASIC |
普通云盘 |
CLOUD_PREMIUM |
高效云盘 |
CLOUD_SSD |
SSD云盘 |
标明了自动续费的方式
ID | 描述 |
---|---|
NOTIFY_AND_MANUAL_RENEW |
通知且不自动续费。(通知即将过期,但不自动续费) |
NOTIFY_AND_AUTO_RENEW |
通知且自动续费 (通知即将过期,而且自动续费) |
DISABLE_NOTIFY_AND_MANUAL_RENEW |
不通知且不自动续费 (不通知即将过期,也不自动续费) |
实例计费模式
ID | 描述 |
---|---|
PREPAID |
预付费,即包年包月 |
POSTPAID_BY_HOUR |
后付费,即按量计费 |
CDHPAID |
`CDH`付费,即只对`CDH`计费,不对`CDH`上的实例计费 |
网络计费模式
ID | 描述 |
---|---|
BANDWIDTH_POSTPAID_BY_MONTH |
按月后付费方式 |
BANDWIDTH_PREPAID |
按带宽计费方式 |
TRAFFIC_POSTPAID_BY_HOUR |
按流量计费方式 |
BANDWIDTH_POSTPAID_BY_HOUR |
按带宽使用时长计费方式 |
BANDWIDTH_PACKAGE |
带宽包计费方式 |
标注镜像来源
ID | 描述 |
---|---|
OFFICIAL |
官方提供的镜像。 |
IMAGE_CREATE |
通过创建实例镜像等方式从官方镜像所派生出的镜像。 |
EXTERNAL_IMPORT |
外部导入的镜像所派生出的镜像。 |
可用区状态
ID | 描述 |
---|---|
AVAILABLE |
可用 |
UNAVAILABLE |
不可用 |
镜像类型
ID | 描述 |
---|---|
PRIVATE_IMAGE |
私有镜像 (本帐户创建的镜像) |
PUBLIC_IMAGE |
公共镜像 (腾讯云官方镜像) |
MARKET_IMAGE |
服务市场 (服务市场提供的镜像) |
SHARED_IMAGE |
共享镜像(其他账户共享给本帐户的镜像) |
镜像状态
ID | 描述 |
---|---|
CREATING |
创建中 |
NORMAL |
正常 |
USING |
使用中 |
SYNCING |
同步中 |
IMPORTING |
导入中 |
DELETING |
删除中 |
目前只于现网提供。
Unresolved directive in book.adoc - include::instance-types.adoc[]