QingCloud 文档 – 云服务器 - kaiyun官方网站下载手机网页

Development_docs: DescribeInstances

Mon, 01 Jan 0001 00:00:00 +0000

获取一个或多个云服务器

可根据云服务器ID, 状态, 云服务器名称, 镜像ID 作过滤条件, 来获取云服务器列表。如果不指定任何过滤条件, 默认返回你所拥有的所有云服务器。

Request Parameters

Parameter name	Type	Description	Required
instances.n	String	云服务器ID	No
image_id.n	String	一个或多个镜像ID	No
instance_type.n	String	云服务器配置类型	No
instance_class	Integer	云服务器性能类型: 性能型:0, 超高性能型:1, 基础型:101, 企业型:201	No
vcpus_current	Integer	云服务器CPU的核心数	No
memory_current	Integer	云服务器内存大小	No
os_disk_size	Integer	云服务器系统盘大小	No
exclude_reserved	Integer	是否过滤预留云服务器, 若为1, 则不返回预留云服务器信息	No
status.n	String	云服务器状态: pending, running, stopped, suspended, terminated, ceased	No
search_word	String	搜索关键词, 支持云服务器ID, 云服务器名称	No
tags.n	String	按照标签ID过滤, 只返回已绑定某标签的资源	No
dedicated_host_group_id	String	按照专属宿云服务器组过滤	No
dedicated_host_id	String	按照专属宿云服务器组中某个宿云服务器过滤	No
owner	String	按照用户账户过滤, 只返回指定账户的资源	No
verbose	Integer	是否返回冗长的信息, 若为1, 则返回云服务器相关其他资源的详细数据。	No
offset	Integer	数据偏移量, 默认为0	No
limit	Integer	返回数据长度，默认为20，最大100	No
zone	String	区域 ID，注意要小写	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
instance_set	Array	JSON 格式的云服务器数据列表, 每项参数可见下面 Response Item
total_count	Integer	根据过滤条件得到的云服务器总数

Response Item

Name	Type	Description
instance_id	String	云服务器ID
instance_name	String	云服务器名称
description	String	云服务器描述
instance_type	String	云服务器类型, 配置列表请参考 Instance Types。
vcpus_current	Integer	云服务器CPU核心数目。
memory_current	Integer	云服务器内存大小, 单位为MB。
status	String	云服务器状态, 有效值为pending, running, stopped, suspended, terminated, ceased。 pending：等待被创建 running：运行中 stopped：已关机 suspended：由于欠费, 已被暂停使用 terminated：已被删除, 但处于此状态的云服务器在2小时之内仍可以被恢复为 running 状态 ceased：已被彻底删除, 处于此状态的云服务器无法恢复
transition_status	String	云服务器过渡状态, 有效值为creating, starting, stopping, restarting, suspending, resuming, terminating, recovering, resetting。 creating：创建中, 由 pending 状态变成 running 状态 starting：启动中, 由 stopped 状态变成 running 状态 stopping：关闭中, 由 running 状态变成 stopped 状态 restarting：重启中 suspending：欠费暂停中, 由 running/stopped 状态变成 suspended 状态 resuming：恢复中, 由 suspended 状态变成 running 状态 terminating：删除中, 由 running/stopped/suspended 状态变成 terminated 状态 recovering：恢复中, 由 terminated 状态变成 running 状态 resetting：操作系统重置中
create_time	TimeStamp	云服务器创建时间, 为UTC时间, 格式可参见 ISO8601.
status_time	TimeStamp	云服务器最近一次状态变更时间, 为UTC时间, 格式可参见 ISO8601.
image	Dict	云服务器的模板信息。 processor_type：支持的处理器类型, 有效值为 64bit 和 32bit platform：模板平台, 有效值为 linux 和 windows os_family：模板操作系统平台, 有效值为 windows, centos, ubuntu, debian, fedora等 image_size：模板大小 image_name：模板名称 provider：模板提供方, 有效值为系统模板( system ), 自有模板 ( self )
vxnets	Array	云服务器加入的私有网络信息。 vxnet_id：私有网络ID vxnet_name：私有网络名称 vxnet_type：私有网络类型, 1 为受管私有网络, 0 为自管私有网络。 nic_id：云服务器加入私有网络的网卡ID private_ip：云服务器位于私有网络中的私有地址
eip	Dict	云服务器绑定的公网 IP 信息。 eip_id：公网 IP 的 ID eip_addr： IP 地址 bandwidth：带宽(Mbps)
security_group	Dict	云服务器的防火墙信息。 security_group_id：防火墙ID is_default：是否为默认防火墙, 1 为是, 0 为不是。只有在请求参数 verbose=1 时才会返回此信息。
volume_ids	Array	云服务器上挂载的硬盘ID 只有在请求参数 verbose=1 时才会返回此信息。
keypair_ids	Array	云服务器上加载的SSH密钥ID 只有在请求参数 verbose=1 时才会返回此信息。
graphics_protocol	String	图形化访问支持协议
graphics_passwd	String	图形化访问密码

Example

Example Request

https://api.qingcloud.com/iaas/?action=DescribeInstances
&instances.1=i-ogbndull
&status.1=running
&verbose=1
&COMMON_PARAMS

Example Response:

{
  "action":"DescribeInstancesResponse",
  "instance_set":[
    {
      "vcpus_current":1,
      "instance_id":"i-ogbndull",
      "volume_ids":[
        "vol-g7xy7d6g",
        "vol-jg7326gy"
      ],
      "vxnets":[
        {
          "vxnet_name":"primary vxnet",
          "vxnet_type":1,
          "vxnet_id":"vxnet-0",
          "nic_id":"52:54:ef:0c:ed:66",
          "private_ip":"10.50.13.54"
        }
      ],
      "eip":{
        "eip_id":"eip-1234abcd",
        "eip_addr":"121.201.5.5",
        "bandwidth":"50"
      },
      "memory_current":1024,
      "sub_code":0,
      "transition_status":"",
      "instance_name":"",
      "instance_type":"small_b",
      "create_time":"2013-08-28T14:26:03Z",
      "status":"running",
      "description":null,
      "security_group":{
        "is_default":1,
        "security_group_id":"sg-z13kokni"
      },
      "status_time":"2013-08-28T14:26:03Z",
      "image":{
        "processor_type":"64bit",
        "platform":"linux",
        "image_size":20,
        "image_name":"CentOS 6.4 64bit",
        "image_id":"centos64x64",
        "os_family":"centos",
        "provider":"system"
      },
      "keypair_ids":[
        "kp-bn2n77ow",
        "kp-05vfs7zs"
      ]
    }
  ],
  "ret_code":0,
  "total_count":1
}

Development_docs: RunInstances

Mon, 01 Jan 0001 00:00:00 +0000

创建指定配置，指定数量的云服务器。

当你创建云服务器时，云服务器会先进入 pending 状态，直到创建完成后，变为 running 状态。你可以使用 DescribeInstances 检查云服务器状态。

创建云服务器时，一旦参数 vxnets.n 包含基础网络（即： vxnet-0 ），则需要指定防火墙 security_group，如果没有指定，开·云app官方版下载会自动使用缺省防火墙。

开·云app官方版下载给云服务器定义了几种经典配置，可通过参数 instance_type 指定，配置列表请参考 Instance Types 。如果经典配置不能满足你的需求，可通过参数 cpu, memory 自定义云服务器配置。

如果参数中既指定 instance_type ，又指定了 cpu 和 memory ，则以指定的 cpu 和 memory 为准。

Request Parameters

Parameter name	Type	Description	Required
image_id	String	镜像ID，此镜像将作为云服务器的模板。可传开·云app官方版下载提供的镜像ID，或自己创建的镜像ID	Yes
instance_type	String	云服务器类型，有效值请参考 Instance Types 如果使用弹性裸金属服务器, 该参数必填。如果请求中指定了 instance_type，cpu 和 memory 参数可略过。如果请求中没有 instance_type，则 cpu 和 memory 参数必须指定。如果请求参数中既有 instance_type，又有 cpu 和 memory，则以 cpu, memory 的值为准。	No
cpu	Integer	CPU core，有效值为: 1, 2, 4, 8, 16	No
memory	Integer	内存，有效值为: 1024, 2048, 4096, 6144, 8192, 12288, 16384, 24576, 32768	No
os_disk_size	Integer	系统盘大小，单位GB。 Linux操作系统的有效值为：20-100，默认值为：20 Windows操作系统的有效值为：50-100，默认值为：50	No
count	Integer	创建云服务器的数量，默认是1 注解当同时创建多台云服务器时，这些云服务器的基本信息和配置都是相同的	No
instance_name	String	云服务器名称	No
login_mode	String	指定登录方式。当为 linux 云服务器时，有效值为 keypair 和 passwd; 当为 windows 云服务器时，只能选用 passwd 登录方式。当登录方式为 keypair 时，需要指定 login_keypair 参数；当登录方式为 passwd 时，需要指定 login_passwd 参数。	Yes
login_keypair	String	登录密钥ID。	No
login_passwd	String	登录密码。	No
vxnets.n	String	云服务器要加入的私有网络ID，如果不传此参数，则表示不加入到任何网络。如果是自建的受管私有网络（不包括基础网络 vxnet-0 ），则可以在创建云服务器时指定内网IP，这时参数值要改为 ``` vxnet-id	ip-address `，如`vxnet-abcd123
security_group	String	云服务器加载的防火墙ID，只有在 vxnets.n 包含基础网络（即：vxnet-0）时才需要提供。若未提供，则默认加载缺省防火墙	No
volumes.n	String	云服务器创建后自动加载的硬盘ID，如果传此参数，则参数 count 必须为1 。	No
hostname	String	可指定云服务器的 hostname 。	No
need_newsid	Integer	1: 生成新的SID，0: 不生成新的SID, 默认为0；只对Windows类型云服务器有效。	No
instance_class	Integer	云服务器性能类型: 性能型:0, 超高性能型:1, 基础型:101, 企业型:201	No
cpu_model	String	CPU 指令集, 有效值: Westmere, SandyBridge, IvyBridge, Haswell, Broadwell	No
cpu_topology	String	CPU 拓扑结构: 插槽数, 核心数, 线程数; 插槽数 * 核心数 * 线程数应等于您应选择的CPU数量。	No
gpu	Integer	GPU 个数	No
gpu_class	Integer	GPU 类型，有效值有 0 和 1 。0 对应的是 NVIDIA P100，1 对应的是 AMD S7150	No
nic_mqueue	Integer	网卡多对列: 关闭(默认)：0，开启：1	No
need_userdata	Integer	1: 使用 User Data 功能；0: 不使用 User Data 功能；默认为 0 。	No
userdata_type	String	User Data 类型，有效值：’plain’, ‘exec’ 或 ‘tar’。为 ‘plain’或’exec’ 时，使用一个 Base64 编码后的字符串；为 ‘tar’ 时，使用一个压缩包（种类为 zip，tar，tgz，tbz）。	No
userdata_value	String	User Data 值。当类型为 ‘plain’ 时，为字符串的 Base64 编码值，长度限制 4K；当类型为 ‘tar’，为调用 UploadUserDataAttachment 返回的 attachment_id。	No
userdata_path	String	User Data 和 MetaData 生成文件的存放路径。不输入或输入不合法时，为默认目录 /etc/qingcloud/userdata	No
userdata_file	String	userdata_type 为 ‘exec’ 时，指定生成可执行文件的路径，默认为/etc/rc.local	No
target_user	String	目标用户 ID ，可用于主账号为其子账号创建资源。	No
dedicated_host_group_id	String	虚机创建到指定的专属宿云服务器组中	No
dedicated_host_id	String	虚机创建到某专属宿云服务器组中指定的宿云服务器上	No
instance_group	String	虚机创建加入到指定的云服务器组中	No
hypervisor	String	hypervisor 类型，当前支持 kvm 和 bm, 默认是 kvm	No
os_disk_encryption	Boolean	创建加密云服务器	No
cipher_alg	String	加密使用的算法类型: 目前仅支持 aes256，默认 aes256	No
months	Integer	如果购买合约模式的云服务器，需要传此参数，数值为购买的月份数。	No
auto_renew	Integer	如果购买合约模式的云服务器，可传此参数，数值为合约到期后自动续约的月份数。如果购买合约时不传此参数，合约到期则不会自动续约。	No
zone	String	区域 ID，注意要小写	Yes

Response Elements

Name	Type	Description
action	String	响应动作
instances	Array	创建的云服务器ID列表
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request:

https://api.qingcloud.com/iaas/?action=RunInstances
&vxnets.1=vxnet-0
&instance_type=small_a
&image_id=centos63x64
&COMMON_PARAMS

Example Response:

{
  "action":"RunInstancesResponse",
  "instances":[
    "i-rtyv0968"
  ],
  "job_id":"j-bm6ym3r8",
  "ret_code":0
}

Development_docs: TerminateInstances

Mon, 01 Jan 0001 00:00:00 +0000

销毁一台或多台云服务器。

销毁云服务器的前提，是此云服务器已建立租用信息（租用信息是在创建云服务器成功后，几秒钟内系统自动建立的）。所以正在创建的云服务器（状态为 pending ），以及刚刚创建成功但还没有建立租用信息的云服务器，是不能被销毁的。

警告

已销毁的云服务器开·云app官方版下载会为你保留2小时，如果误操作，请及时与我们联系。

Request Parameters

Parameter name	Type	Description	Required
instances.n	String	一个或多个云服务器ID	Yes
direct_cease	Integer	是否直接彻底销毁云服务器，如果指定 “1” 则不会进入回收站直接销毁，默认是 “0”	No
zone	String	区域 ID，注意要小写	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request:

https://api.qingcloud.com/iaas/?action=TerminateInstances
&instances.1=i-rtyv0968
&zone=pek3a
&COMMON_PARAMS

Example Response:

{
  "action":"TerminateInstancesResponse",
  "job_id":"j-ybnoeitr",
  "ret_code":0
}

Development_docs: StartInstances

Mon, 01 Jan 0001 00:00:00 +0000

启动一台或多台关闭状态的云服务器。

云服务器只有在关闭 stopped 状态才能被启动，如果处于非关闭状态，则返回错误信息。

云服务器在关闭状态时，开·云app官方版下载只收取云服务器操作系统所占磁盘空间的费用，价格与硬盘相同，即：每 10G 收费 0.02 元（注：Linux 系统为 20G，Windows 系统为 50G）。当云服务器启动后，计费系统会继续对此云服务器的计算资源进行扣费。

开·云app官方版下载会根据你实际使用的时长收费（精确到秒），所以你可以随时启动、关闭云服务器，而不用考虑计费周期的限制。

Request Parameters

Parameter name	Type	Description	Required
instances.n	String	一个或多个云服务器ID	Yes
zone	String	区域 ID，注意要小写	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request:

https://api.qingcloud.com/iaas/?action=StartInstances
&instances.1=i-rtyv0968
&zone=pek3a
&COMMON_PARAMS

Example Response:

{
  "action":"StartInstancesResponse",
  "job_id":"j-ybnoeitr",
  "ret_code":0
}

Development_docs: StopInstances

Mon, 01 Jan 0001 00:00:00 +0000

关闭一台或多台运行状态的云服务器。

云服务器只有在运行 running 状态才能被关闭，如果处于非运行状态，则返回错误信息。

开·云app官方版下载会根据你实际使用的时长收费（精确到秒），所以你可以随时启动、关闭云服务器，而不用考虑计费周期的限制。

警告

关闭云服务器不会保存 RAM 中的数据。

Request Parameters

Parameter name	Type	Description	Required
instances.n	String	一个或多个云服务器ID	Yes
force	Integer	1: 强制关机，0: 非强制关机，默认为0	No
zone	String	区域 ID，注意要小写	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request:

https://api.qingcloud.com/iaas/?action=StopInstances
&instances.1=i-rtyv0968
&zone=pek3a
&COMMON_PARAMS

Example Response:

{
  "action":"StopInstancesResponse",
  "job_id":"j-ybnoeitr",
  "ret_code":0
}

Development_docs: RestartInstances

Mon, 01 Jan 0001 00:00:00 +0000

重启一台或多台运行状态的云服务器。

云服务器只有在运行 running 状态才能被重启，如果处于非运行状态，则返回错误信息。

Request Parameters

Parameter name	Type	Description	Required
instances.n	String	一个或多个云服务器ID	Yes
zone	String	区域 ID，注意要小写	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request:

https://api.qingcloud.com/iaas/?action=RestartInstances
&instances.1=i-rtyv0968
&zone=pek3a
&COMMON_PARAMS

Example Response:

{
  "action":"RestartInstancesResponse",
  "job_id":"j-ybnoeitr",
  "ret_code":0
}

Development_docs: ResetInstances

Mon, 01 Jan 0001 00:00:00 +0000

将一台或多台云服务器的系统盘重置到初始状态。被重置的云服务器必须处于运行（ running ）或关闭（ stopped ）状态。

重置只涉及系统盘数据，不包含云服务器所加载的硬盘。

Request Parameters

Parameter name	Type	Description	Required
instances.n	String	一个或多个云服务器ID	Yes
login_mode	String	指定登录方式。当为 linux 云服务器时，有效值为 keypair 和 passwd; 当为 windows 云服务器时，只能选用 passwd 登录方式。当登录方式为 keypair 时，需要指定 login_keypair 参数；当登录方式为 passwd 时，需要指定 login_passwd 参数。	Yes
login_keypair	String	登录密钥ID。	No
login_passwd	String	登录密码。	No
need_newsid	Integer	1: 生成新的SID，0: 不生成新的SID, 默认为0；只对Windows类型云服务器有效。	No
zone	String	区域 ID，注意要小写	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request:

https://api.qingcloud.com/iaas/?action=ResetInstances
&instances.1=i-rtyv0968
&zone=pek3a
&COMMON_PARAMS

Example Response:

{
  "action":"ResetInstancesResponse",
  "job_id":"j-ybnoeitr",
  "ret_code":0
}

Development_docs: ResizeInstances

Mon, 01 Jan 0001 00:00:00 +0000

修改云服务器配置，包括 CPU 和内存。云服务器状态必须是关闭的 stopped ，不然会返回错误。

如果使用预设的 instance_type ，参数中就不需再指定 CPU 或内存，配置列表请参考 Instance Types 。

如果参数中没有指定 instance_type ，则必须指定 cpu 和 memory。

如果参数中既指定 instance_type ，又指定了 cpu 和 memory ，则以指定的 cpu 和 memory 为准。

Request Parameters

Parameter name	Type	Description	Required
instances.n	String	云服务器ID	Yes
instance_type	String	云服务器类型，有效值请参考 Instance Types 如果请求中指定了 instance_type，cpu 和 memory 参数可略过。如果请求中没有 instance_type，则 cpu 和 memory 参数必须指定。如果请求参数中既有 instance_type，又有 cpu 和 memory，则以 cpu, memory 的值为准。	No
cpu	Integer	CPU core，有效值为: 1, 2, 4, 8, 16	No
memory	Integer	内存，有效值为: 1024, 2048, 4096, 6144, 8192, 12288, 16384, 24576, 32768	No
os_disk_size	Integer	系统盘大小，单位GB。 Linux操作系统的有效值为：20-100，默认值为：20 Windows操作系统的有效值为：50-100，默认值为：50	No
cpu_model	String	CPU 指令集, 有效值: Westmere, SandyBridge, IvyBridge, Haswell, Broadwell	No
cpu_topology	String	CPU 拓扑结构: 插槽数, 核心数, 线程数; 插槽数 * 核心数 * 线程数应等于您应选择的CPU数量。	No
gpu	Integer	GPU 个数	No
zone	String	区域 ID，注意要小写	No

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request:

https://api.qingcloud.com/iaas/?action=ResizeInstances
&instance_type=medium_a
&instances.1=i-r4jnbhui
&zone=pek3a
&COMMON_PARAMS

Example Response:

{
  "action":"ResizeInstancesResponse",
  "job_id":"j-cT9nUFvT",
  "ret_code":0
}

Development_docs: ModifyInstanceAttributes

Mon, 01 Jan 0001 00:00:00 +0000

修改一台云服务器的名称和描述。

修改时不受云服务器状态限制。一次只能修改一台云服务器。

Request Parameters

Parameter name	Type	Description	Required
instance	String	云服务器ID	Yes
instance_name	String	云服务器名称	No
description	String	云服务器描述	No
zone	String	区域 ID，注意要小写	Yes
nic_mqueue	Integer	1: 启用网卡多队列功能，0: 禁用网卡多队列功能, 默认为0	No

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request:

https://api.qingcloud.com/iaas/?action=ModifyInstanceAttributes
&instance=i-rtyv0968
&instance_name=sample
&zone=pek3a
&COMMON_PARAMS

Example Response:

{
  "action":"ModifyInstanceAttributesResponse",
  "ret_code":0
}

Development_docs: DescribeInstanceTypes

Mon, 01 Jan 0001 00:00:00 +0000

获取区域支持的云服务器类型

Request Parameters

Parameter name	Type	Description	Required
zone	String	区域 ID，注意要小写	Yes
instance_types	Array	指定查询的云服务器类型	No
baremetal	Integer	是否返回物理机的云服务器类型，”1” 则返回物理机支持的类型，默认 “0”	No

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
instance_type_set	Array	JSON 格式的云服务器类型列表, 每项参数可见下面 Response Item
total_count	Integer	根据过滤条件得到的云服务器类型总数

Response Item

Name	Type	Description
instance_type_id	String	云服务器类型ID
instance_type_name	String	云服务器类型名称
description	String	云服务器类型描述
vcpus_current	Integer	云服务器类型CPU核心数目。
memory_current	Integer	云服务器类型内存大小, 单位为MB。
status	String	云服务器类型状态, 有效值为available, deprecated。 available：可用的云服务器类型 deprecated：已废弃的云服务器类型

Example

Example Request

https://api.qingcloud.com/iaas/?action=DescribeInstanceTypes
&instance_types.1=c1m1
&zone=pek3a
&COMMON_PARAMS

Example Response:

{
  "action":"DescribeInstanceTypesResponse",
  "total_count":1,
  "instance_type_set":[
    {
      "vcpus_current":1,
      "status":"available",
      "description":"",
      "instance_type_name":"1核1G",
      "instance_type_id":"c1m1",
      "zone_id":"pek3a",
      "memory_current":1024
    }
  ],
  "ret_code":0
}

Development_docs: CreateBrokers

Mon, 01 Jan 0001 00:00:00 +0000

为指定的云服务器创建远程桌面代理。

Request Parameters

Parameter name	Type	Description	Required
instances.n	String	云服务器 ID 列表	Yes
zone	String	区域 ID	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
brokers	Array	新创建的远程桌面代理列表，每项参数可见下面 Response Item
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Response Item

Name	Type	Description
instance_id	String	云服务器 ID
broker_host	String	远程桌面代理域名
broker_port	Integer	远程桌面代理端口

Example

Example Request

https://api.qingcloud.com/iaas/?action=CreateBrokers
&instances.1=i-1tv6ffcy
&zone=gd2
&COMMON_PARAMS

Example Response:

{
  "action":"CreateBrokersResponse",
  "brokers":[
    {
      "instance_id":"i-1tv6ffcy",
      "broker_port":23239,
      "broker_host":"broker.qingcloud.com"
    }
  ],
  "ret_code":0
}

Development_docs: DeleteBrokers

Mon, 01 Jan 0001 00:00:00 +0000

删除指定云服务器的远程桌面代理。

Request Parameters

Parameter name	Type	Description	Required
instances.n	String	云服务器 ID 列表	Yes
zone	String	区域 ID	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
brokers	Array	被删除的远程桌面代理列表
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request

https://api.qingcloud.com/iaas/?action=DeleteBrokers
&instances.1=i-1tv6ffcy
&zone=gd2
&COMMON_PARAMS

Example Response:

{
  "action":"DeleteBrokersResponse",
  "brokers":[
    {
      "instance_id":"i-1tv6ffcy"
    }
  ],
  "ret_code":0
}

Development_docs: CreateInstanceGroups

Mon, 01 Jan 0001 00:00:00 +0000

创建云服务器组。

Request Parameters

Parameter name	Type	Description	Required
relation	String	云服务器组关系	Yes
zone	String	区域 ID，注意要小写	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
instance_groups	Array	新创建的云服务器组列表
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request

https://api.qingcloud.com/iaas/?action=CreateInstanceGroups
&relation=repel
&zone=gd2
&COMMON_PARAMS

Example Response:

{
  "action":"CreateInstanceGroupsResponse",
  "instance_groups":[
    "ig-c7v8lro1"
  ],
  "ret_code":0
}

Development_docs: DeleteInstanceGroups

Mon, 01 Jan 0001 00:00:00 +0000

删除指定云服务器组。

Request Parameters

Parameter name	Type	Description	Required
instance_groups.n	String	云服务器分组 ID 列表	Yes
zone	String	区域 ID	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
instance_groups	Array	被删除的云服务器组列表
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request

https://api.qingcloud.com/iaas/?action=DeleteInstanceGroups
&instance_groups.1=ig-c7v8lro1
&zone=gd2
&COMMON_PARAMS

Example Response:

{
  "action":"DeleteInstanceGroupsResponse",
  "instance_groups":[
    "ig-c7v8lro1"
  ],
  "ret_code":0
}

Development_docs: JoinInstanceGroup

Mon, 01 Jan 0001 00:00:00 +0000

云服务器加入指定的云服务器组。

Request Parameters

Parameter name	Type	Description	Required
instances.n	String	一个或多个云服务器ID	Yes
instance_group	String	云服务器组 ID	Yes
zone	String	区域 ID，注意要小写	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request

https://api.qingcloud.com/iaas/?action=JoinInstanceGroup
&instances.1=i-ipot8lz8
&instance_group=ig-st962mj0
&zone=gd2
&COMMON_PARAMS

Example Response:

{
  "action":"JoinInstanceGroupResponse",
  "job_id":"j-fuundcqh"
  "ret_code":0
}

Development_docs: LeaveInstanceGroup

Mon, 01 Jan 0001 00:00:00 +0000

云服务器离开指定的云服务器组。

Request Parameters

Parameter name	Type	Description	Required
instances.n	String	一个或多个云服务器ID	Yes
instance_group	String	云服务器组 ID	Yes
zone	String	区域 ID，注意要小写	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request

https://api.qingcloud.com/iaas/?action=LeaveInstanceGroup
&instances.1=i-ipot8lz8
&instance_group=ig-st962mj0
&zone=gd2
&COMMON_PARAMS

Example Response:

{
  "action":"LeaveInstanceGroupResponse",
  "job_id":"j-mcacahmw",
  "ret_code":0
}

Development_docs: DescribeInstanceGroups

Mon, 01 Jan 0001 00:00:00 +0000

获取一个或多个云服务器组

可根据云服务器组ID, 分组名称, 分组关系作为过滤条件, 来获取云服务器组列表。如果不指定任何过滤条件, 默认返回你所拥有的所有云服务器组。

Request Parameters

Parameter name	Type	Description	Required
instance_groups.n	String	云服务器组ID	No
relation	String	云服务器分组关系	No
tags.n	String	按照标签ID过滤, 只返回已绑定某标签的资源	No
owner	String	按照用户账户过滤, 只返回指定账户的资源	No
verbose	Integer	是否返回冗长的信息, 若为1, 则返回云服务器组相关其他资源的详细数据。	No
offset	Integer	数据偏移量, 默认为0	No
limit	Integer	返回数据长度，默认为20，最大100	No
zone	String	区域 ID，注意要小写	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
instance_group_set	Array	JSON 格式的云服务器组数据列表, 每项参数可见下面 Response Item
total_count	Integer	根据过滤条件得到的云服务器组总数

Response Item

Name	Type	Description
instance_group_id	String	云服务器组ID
instance_group_name	String	云服务器组名称
description	String	云服务器组描述
relation	String	云服务器组关系
create_time	TimeStamp	云服务器组创建时间, 为UTC时间, 格式可参见 ISO8601.

Example

Example Request

https://api.qingcloud.com/iaas/?action=DescribeInstanceGroups
&instance_groups.1=ig-8qstg3wi
&verbose=1
&zone=gd2
&COMMON_PARAMS

Example Response:

{
  "action":"DescribeInstanceGroupsResponse",
  "total_count":1,
  "instance_group_set":[
    {
      "instance_group_name":"attract",
      "description":"",
      "tags":[],
      "controller":"self",
      "console_id":"alphacloud",
      "root_user_id":"usr-97aasaOZ",
      "create_time":"2017-10-27T03:46:06Z",
      "relation":"attract",
      "owner":"usr-97aasaOZ",
      "instance_group_id":"ig-8qstg3wi"
    }
  ],
  "ret_code":0
}

Development_docs: CloneInstances

Mon, 01 Jan 0001 00:00:00 +0000

拷贝一台或多台机器。

拷贝云服务器的前提，是此云服务器对应的镜像可用、没有被删除掉。云服务器处于运行或关机状态。

提醒

拷贝后的云服务器处于运行状态。原云服务器的硬盘等也会拷贝并挂载到目标云服务器。

Request Parameters

Parameter name	Type	Description	Required
instances.n	String	一个或多个云服务器ID	Yes
vxnets.n	String	一个或多个云服务器克隆生成的新云服务器的vxnet或ip地址格式是: ‘instance_id\|vxnet_id\|ip_addr’	No
zone	String	区域 ID，注意要小写	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request:

https://api.qingcloud.com/iaas/?action=CloneInstances
&instances.1=i-xrvfi3jx
&instances.2=i-w2kcs8vb
&vxnets.1='i-xrvfi3jx|vxnet-q57edqv|172.30.10.21'
&vxnets.2='i-w2kcs8vb|vxnet-3m9hetp'
&zone=pek3a
&COMMON_PARAMS

Example Response:

recv: {
  "action":"CloneInstancesResponse",
  "instance_set":{
    "i-w2kcs8vb":{
      "instance_map":{
        "i-w2kcs8vb":"i-fckrkm13"
      }
    },
    "i-xrvfi3jx":{
      "instance_map":{
        "i-xrvfi3jx":"i-ebnp872h"
      },
      "volumes_map":{
        "vol-hl83huq8":"vol-635nsvoh",
        "vol-ttgud6t1":"vol-tl0y9w2f"
      }
    }
  },
  "ret_code":0,
  "job_id":"j-nlxw1url8uw",
  "instances":[
    "i-ebnp872h",
    "i-fckrkm13"
  ]
}

Development_docs: CeaseInstances

Mon, 01 Jan 0001 00:00:00 +0000

从回收站销毁一台或多台云服务器。

销毁云服务器的前提，是此云服务器已被删除并进入回收站。

警告

已销毁的云服务器会直接从回收站销毁，无法再恢复，如果误操作，请及时与我们联系。

Request Parameters

Parameter name	Type	Description	Required
instances.n	String	一个或多个云服务器ID	Yes
zone	String	区域 ID，注意要小写	Yes

公共参数

Response Elements

Name	Type	Description
action	String	响应动作
job_id	String	执行任务的 Job ID
ret_code	Integer	执行成功与否，0 表示成功，其他值则为错误代码

Example

Example Request:

https://api.qingcloud.com/iaas/?action=CeaseInstances
&instances.1=i-rtyv0968
&zone=pek3a
&COMMON_PARAMS

Example Response:

{
  "action":"CeaseInstancesResponse",
  "job_id":"j-ybnoeitr",
  "ret_code":0
}