创建云服务器

功能介绍

创建一台或多台云服务器。

V1.1版本创建云服务器的接口兼容了V1版本创建云服务器（按需）的功能，同时合入新功能，支持创建包年/包月的弹性云服务器。

本接口为异步接口，当前创建云服务器请求下发成功后会返回job_id，此时创建云服务器并没有立即完成，需要通过调用查询任务的执行状态查询job状态，当Job状态为 SUCCESS 时代表云服务器创建成功。

本接口支持在HTTP请求消息头中设置X-Client-Token请求头，保证请求幂等性。详细信息请参考请求幂等性说明。

接口约束

• 创建包年/包月云服务器时，支持自动支付和手动支付。
  • 如果将请求中的isAutoPay字段设置为true，表示采用自动支付方式，系统会自动匹配账户支持的付款方式进行扣费。
    • 自动支付支持的付款方式和顺序如下：

      折扣优惠（每次只能使用一项）→代金券（每次只能使用一张）→现金券或储值卡（每次可使用多张，可同时使用）→账户余额（先扣现金额度后扣信用额度）或月末结算

    • 如果上述付款方式无法完成支付，系统会自动生成一个待支付订单，您可以手动在控制台上选择支付方式进行支付。

    自动支付的更多内容请参见自动支付。

  • 如果将请求中的isAutoPay字段设置为false，表示采用手动支付方式，系统会自动生成一个待支付订单，您可以手动在控制台上选择支付方式进行支付。
• 创建按需计费云服务器时，系统会自动匹配适用的代金券进行使用。
• 如果您需要退订该包年/包月资源，请参考“退订包年/包月资源”。

调试

您可以在API Explorer中调试该接口。

URI

• URI格式

  POST /v1.1/{project_id}/cloudservers

• 参数说明

  参数	是否必选	描述
  project_id	是	项目ID 获取方法请参见 获取项目ID

请求消息

响应消息

异常响应请参考响应（任务类），异常响应要素说明。

请求示例

• 创建一台包年/包月云服务器，操作系统为CentOS 7.6 64bit，1U1G，绑定1M带宽的弹性公网IP，采用密钥方式登录鉴权。

  POST https://{endpoint}/v1.1/{project_id}/cloudservers
  
  {
      "server": {
          "availability_zone":"az1-dc1",
          "name": "newserver", 
          "imageRef": "67f433d8-ed0e-4321-a8a2-a71838539e09", 
          "root_volume": {
              "volumetype": "SSD"
          }, 
          "data_volumes": [
              {
                  "volumetype": "SSD", 
                  "size": 100
              }, 
              {
                  "volumetype": "SSD", 
                  "size": 100,
                  "multiattach": true,
                  "hw:passthrough": true
              }
          ], 
          "flavorRef": "s2.small.1", 
          "vpcid": "2a6f4aa6-d93e-45f5-a8cb-b030dbf8cd68", 
          "security_groups": [
              {
                  "id": "6242ef48-4d35-49c8-8711-a6e54902e44a"
              }
          ], 
          "nics": [
              {
                  "subnet_id": "ef039b60-6a14-42d1-963b-687b627fea08"
              }
          ], 
          "publicip": {
              "eip": {
                  "iptype": "5_sbgp",
                  "bandwidth": {
                      "size": 1, 
                      "sharetype": "PER"
                  }
              }
          }, 
          "key_name": "id_rsa", 
          "count": 1, 
          "metadata": {
              "op_svc_userid": "f79791beca3c48159ac2553fff22e166"
          },
          "extendparam": { 
              "chargingMode": "prePaid",
              "periodType": "month",
              "periodNum": 1,
              "isAutoRenew": "true",
              "isAutoPay": "true",
              "enterprise_project_id": "f8e0ecc8-3825-4ee8-9596-fb4258ffdcbb"
          },
          "os:scheduler_hints": {
            "group": "cdbbfffe-ef18-47b4-a5c8-f61a984c0ecc"
          }
          
      }
  }

• 创建一台包年/包月云服务器，操作系统为CentOS 7.6 64bit，1U1G，绑定1M带宽的弹性公网IP，采用密码方式登录鉴权请求中的密码，建议将密码在配置文件或者环境变量中密文存放，使用时解密，确保安全。

  POST https://{endpoint}/v1.1/{project_id}/cloudservers
  
  {
      "server": {
          "availability_zone":"az1-dc1",
          "name": "newserver",
          "adminPass": "$ADMIN_PASS",   
          "imageRef": "67f433d8-ed0e-4321-a8a2-a71838539e09",
          "root_volume": {
              "volumetype": "SSD"
          },
          "data_volumes": [
              {
                  "volumetype": "SSD",
                  "size": 100
              },
              {
                  "volumetype": "SSD",
                  "size": 100,
                  "multiattach": true,
                  "hw:passthrough": true
              }
          ],
          "flavorRef": "s2.small.1",
          "vpcid": "2a6f4aa6-d93e-45f5-a8cb-b030dbf8cd68",
          "security_groups": [
              {
                  "id": "6242ef48-4d35-49c8-8711-a6e54902e44a"
              }
          ],
          "nics": [
              {
                  "subnet_id": "ef039b60-6a14-42d1-963b-687b627fea08"
              }
          ],
          "publicip": {
              "eip": {
                  "iptype": "5_sbgp",
                  "bandwidth": {
                      "size": 1,
                      "sharetype": "PER"
                  }
              }
          },
          "key_name": "",
          "count": 1,
          "metadata": {},
          "extendparam": {
              "chargingMode": "prePaid",
              "periodType": "month",
              "periodNum": 1,
              "isAutoRenew": "true",
              "isAutoPay": "true",
              "enterprise_project_id": "f8e0ecc8-3825-4ee8-9596-fb4258ffdcbb"
          },
          "os:scheduler_hints": {
              "group": "cdbbfffe-ef18-47b4-a5c8-f61a984c0ecc"
          }
      }
  }

• 创建一台包年/包月云服务器，操作系统为CentOS 7.6 64bit，1U1G，绑定1M带宽的按需按流量计费的弹性公网IP，采用密钥方式登录鉴权。

  POST https://{endpoint}/v1.1/{project_id}/cloudservers
  
  {
      "server": {
          "availability_zone":"az1-dc1",
          "name": "newserver", 
          "imageRef": "67f433d8-ed0e-4321-a8a2-a71838539e09", 
          "root_volume": {
              "volumetype": "SSD"
          }, 
          "data_volumes": [
              {
                  "volumetype": "SSD", 
                  "size": 100
              }, 
              {
                  "volumetype": "SSD", 
                  "size": 100,
                  "multiattach": true,
                  "hw:passthrough": true
              }
          ], 
          "flavorRef": "s2.small.1", 
          "vpcid": "2a6f4aa6-d93e-45f5-a8cb-b030dbf8cd68", 
          "security_groups": [
              {
                  "id": "6242ef48-4d35-49c8-8711-a6e54902e44a"
              }
          ], 
          "nics": [
              {
                  "subnet_id": "ef039b60-6a14-42d1-963b-687b627fea08"
              }
          ], 
          "publicip": {
              "eip": {
                  "iptype": "5_sbgp",
                  "bandwidth": {
                      "size": 1, 
                      "sharetype": "PER",
                      "chargemode": "traffic"
                  },
                  "extendparam": {
                      "chargingMode": "postPaid"
                  }
              }
          }, 
          "key_name": "id_rsa", 
          "count": 1, 
          "metadata": {
              "op_svc_userid": "f79791beca3c48159ac2553fff22e166"
          },
          "extendparam": { 
              "chargingMode": "prePaid",
              "periodType": "month",
              "periodNum": 1,
              "isAutoRenew": "true",
              "isAutoPay": "true",
              "enterprise_project_id": "f8e0ecc8-3825-4ee8-9596-fb4258ffdcbb"
          },
          "os:scheduler_hints": {
            "group": "cdbbfffe-ef18-47b4-a5c8-f61a984c0ecc"
          }
      }
  }

• 创建一台包年/包月云服务器，操作系统为CentOS 7.6 64bit，1U1G，绑定共享带宽的弹性公网IP，采用密钥方式登录鉴权。

  POST https://{endpoint}/v1.1/{project_id}/cloudservers
  
  {
      "server": {
          "availability_zone":"az1-dc1",
          "name": "newserver", 
          "imageRef": "67f433d8-ed0e-4321-a8a2-a71838539e09", 
          "root_volume": {
              "volumetype": "SSD"
          }, 
          "data_volumes": [
              {
                  "volumetype": "SSD", 
                  "size": 100
              }, 
              {
                  "volumetype": "SSD", 
                  "size": 100,
                  "multiattach": true,
                  "hw:passthrough": true
              }
          ], 
          "flavorRef": "s2.small.1", 
          "vpcid": "2a6f4aa6-d93e-45f5-a8cb-b030dbf8cd68", 
          "security_groups": [
              {
                  "id": "6242ef48-4d35-49c8-8711-a6e54902e44a"
              }
          ], 
          "nics": [
              {
                  "subnet_id": "ef039b60-6a14-42d1-963b-687b627fea08"
              }
          ], 
          "publicip": {
              "eip": {
                  "iptype": "5_sbgp",
                  "bandwidth": {
                      "id": "a0d4b26f-699d-49a0-bcc8-6f707a925abf",
                      "sharetype": "WHOLE"
                  }
              }
          }, 
          "key_name": "id_rsa", 
          "count": 1, 
          "metadata": {
              "op_svc_userid": "f79791beca3c48159ac2553fff22e166",
              "agency_name": "test"
          },
          "extendparam": { 
              "chargingMode": "prePaid",
              "periodType": "month",
              "periodNum": 1,
              "isAutoRenew": "true",
              "isAutoPay": "true",
              "enterprise_project_id": "f8e0ecc8-3825-4ee8-9596-fb4258ffdcbb"
          },
          "os:scheduler_hints": {
            "group": "cdbbfffe-ef18-47b4-a5c8-f61a984c0ecc"
          }
      }
  }

响应示例

{
    "job_id": "ff808082739334d80173943ec9b42130",
    "order_id": "CS2007281506xxxxx",
    "serverIds": [
        "fe0528f0-5b1c-4c8c-9adf-e5d5047b8c17",
        "679854ae-a50d-40c9-8132-b19bf3a306a1"
    ] 
}

或

{
    "error": {
        "code": "Ecs.0005", 
        "message": "request body is illegal."
    }
}

返回值

请参考通用请求返回值。

错误码

请参考错误码。