执行API
更新时间：2024-08-16
用途
此Operator可以用来调用某个云产品（如云服务器BCC）的OpenAPI。
支持的API操作
BCC：创建/删除/开机/关机/重启
EIP：创建/删除/绑定BCC
ENI：创建/删除/绑定BCC/绑定EIP
CDS：创建/删除/绑定BCC
参数
| 名称 | 类型 | 描述 |
|---|---|---|
| name | String | 模板任务名称，必填 |
| operator | String | 模板任务类型，必填 |
| properties | Map<String, Object> | 任务执行所需参数，必填，详细内容见下表 |
properties参数
| 名称 | 类型 | 描述 |
|---|---|---|
| serviceName | String | 必填，云产品名称，当前支持BCC、EIP、ENI、CDS四种云产品 |
| apiName | String | 必填，云产品的API名称，当前仅支持创建/删除，部分云产品支持绑定操作，详见【用途-支持的API操作】【API帮助】 |
| parameters | Object | 选填,调用OpenAPI所需要的参数，具体参考【API帮助】中的参考API文档 |
示例
{
"name":"executeAPI"
"operator": "BCE::ExecuteAPI",
"properties": {
"serviceName": "BCC",
"apiName": "CreateInstanceBySpec",
"parameters": {
"imageId": "m-8S2nu8s3",
"spec": "bcc.g3.c1m1",
"name": "test_YYY1_bcc",
"rootDiskSizeInGb": 40,
"purchaseCount": 1,
"billing": {
"paymentTiming": "Postpaid",
"reservation": {
"reservationLength": 1,
"reservationTimeUnit": "Month"
}
}
}
}
}API帮助
BCC
| API名称 | 参考API文档 |
|---|---|
| CreateInstanceBySpec | https://cloud.baidu.com/doc/BCC/s/2k3rau7n4 |
| DeleteInstanceBySpec | https://cloud.baidu.com/doc/BCC/s/2jwvyoclc |
EIP
| API名称 | 参考API文档 |
|---|---|
| Create | https://cloud.baidu.com/doc/EIP/s/Wjwvz30fv |
| Delete | https://cloud.baidu.com/doc/EIP/s/Rjwvz32ig |
| Bind | https://cloud.baidu.com/doc/EIP/s/9jwvz31gn |
ENI
| API名称 | 参考API文档 |
|---|---|
| Create | https://cloud.baidu.com/doc/VPC/s/pkknfara0 |
| Delete | https://cloud.baidu.com/doc/VPC/s/ikknfinx7 |
| BindEip | https://cloud.baidu.com/doc/VPC/s/vkknfr857 |
| AttachBcc | https://cloud.baidu.com/doc/VPC/s/qkknfp44w |
CDS
| API名称 | 参考API文档 |
|---|---|
| Create | https://cloud.baidu.com/doc/BCC/s/Ujwvyo1ta |
| Delete | https://cloud.baidu.com/doc/BCC/s/1jwvyo4xu |
| AttachBcc | https://cloud.baidu.com/doc/BCC/s/Yjwvyo3xg |
Console使用说明
创建BCC/创建CDS
通过执行API创建BCC/CDS除【订单、计费相关参数】以外其他参数输入和直接执行创建BCC/CDS的操作符一致
【订单、计费相关参数】输入说明
订单信息定义
Billing
| 参数名称 | 类型 | 描述 |
|---|---|---|
| paymentTiming | String | 付费方式，包括预支付（Prepaid）和后支付（Postpaid） |
| reservation | Reservation | 保留信息，支付方式为后支付时不需要设置，预支付时必须设置 |
Reservation
| 参数名称 | 类型 | 描述 |
|---|---|---|
| reservationLength | int | 时长，[1,2,3,4,5,6,7,8,9,12,24,36] |
| reservationTimeUnit | String | 时间单位，Month，当前仅支持按月 |
输入示例
{
"paymentTiming": "Prepaid",
"reservation": {
"reservationLength": 1,
"reservationTimeUnit": "Month"
}
}创建EIP
通过执行API创建EIP除【订单、计费相关参数】以外其他参数输入和直接执行创建EIP的操作符一致
订单信息定义
Billing
| 参数名称 | 类型 | 描述 |
|---|---|---|
| paymentTiming | String | 付费方式，包括预支付（Prepaid）和后支付（Postpaid） |
| billingMethod | String | 计费方式，按流量（ByTraffic）、按带宽（ByBandwidth）、按增强95（ByPeak95）（只有共享带宽后付费支持），后支付时必须设置 |
| reservation | Reservation | 保留信息，支付方式为后支付时不需要设置，预支付时必须设置 |
Reservation
| 参数名称 | 类型 | 描述 |
|---|---|---|
| reservationLength | int | 时长，[1,2,3,4,5,6,7,8,9,12,24,36] |
| reservationTimeUnit | String | 时间单位，Month，当前仅支持按月 |
输入示例
{
"paymentTiming": "Prepaid",
"billingMethod": "ByTraffic",
"reservation": {
"reservationLength": 1,
"reservationTimeUnit": "Month"
}
}创建ENI
通过执行API创建ENI除【内网IPv4】【内网IPv6】以外其他参数输入和直接执行创建EIP的操作符一致
内网IPv4/内网IPv6
Billing
| 参数名称 | 类型 | 描述 |
|---|---|---|
| publicIpAddress | String | 弹性网卡的公网Ip地址，即eip地址 |
| primary | boolean | 是否是主Ip |
| privateIpAddress | String | 弹性网卡的内网Ip地址 |
输入示例
{
"primary": true,
"privateIpAddress": "2400:da00:e003:0:1d2:100:0:12"
}