概述
云平台向用户开放所有项目操作相关的 API，API 通过 HTTPS GET 方式来进行调用。
在调用 API 前，需要先申请 API 密钥，获取 API 密钥 ID（access_key_id） 和 API 密钥私钥（secret_access_key）。
-
API 密钥 ID 将作为参数包含在每一个请求中发送。
-
API 密钥私钥负责生成请求串的签名进行鉴权。
| 说明 |
|---|
API 密钥的私钥需要被妥善保管，请勿外传。 |
本文档提供对项目进行相关操作，如对项目、项目角色进行增、删、改、查等。
API 请求结构
API 请求样例
一个典型的 API 请求如下所示，这是一个 DescribeInstances 的 API 请求:
https://api.qingcloud.com/iaas/?access_key_id=QYACCESSKEYIDEXAMPLE&action=DescribeInstances&expires=2013-08-29T07%3A42%3A25Z&limit=20&signature_method=HmacSHA256&signature_version=1&status.1=running&time_stamp=2013-08-29T06%3A42%3A25Z&version=1&zone=pek3b&signature=ihPnXFgsg5yyqhDN2IejJ2%2Bbo89ABQ1UqFkyOdzRITY%3D为了方便查看，我们将文档中的请求都进行换行来显示.
https://api.qingcloud.com/iaas/?access_key_id=QYACCESSKEYIDEXAMPLE
&action=DescribeInstances
&expires=2013-08-29T07%3A42%3A25Z
&limit=20
&signature_method=HmacSHA256
&signature_version=1
&status.1=running
&time_stamp=2013-08-29T06%3A42%3A25Z
&version=1
&zone=pek3b
&signature=ihPnXFgsg5yyqhDN2IejJ2%2Bbo89ABQ1UqFkyOdzRITY%3DAPI 返回结构
| 参数 | 描述 | 说明 |
|---|---|---|
指令名称 |
API 返回的指令名称（action），例如：DescribeInstancesResponse 等 |
API 返回的指令名称一般以 |
返回码 |
返回码（ |
- |
返回参数 |
返回参数请参见每个指令的相关文档 |
- |
API 返回样例
API 的返回结果为 JSON 结构，这是一个 DescribeInstances 的 API 请求返回。
{
"action":"DescribeInstancesResponse",
"instance_set":[
{
"vcpus_current":1,
"instance_id":"i-ogbndull",
"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"
}
],
"memory_current":1024,
"sub_code":0,
"transition_status":"",
"instance_name":"",
"instance_type":"c1m1",
"create_time":"2013-08-28T14:26:03Z",
"status":"running",
"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"
},
"description":null
}
],
"ret_code":0,
"total_count":1
}API 请求类型
API 请求主要分为延迟请求和实时请求两种。
| 说明 |
|---|
|