調用CreateLogstash,建立一個Logstash執行個體。
在調用介面前,請注意:
- 請確保在調用該介面前,已充分瞭解Logstash產品的付費方式和價格。
- 建立執行個體需要通過實名認證。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
要求標頭
POST /openapi/logstashes
請求文法
POST /openapi/logstashes HTTP/1.1
請求參數
|
名稱 |
類型 |
位置 |
是否必選 |
樣本值 |
描述 |
| clientToken | String | Query | 否 | 5A2CFF0E-5718-45B5-9D4D-70B3FF**** | 用於保證請求的等冪性。由用戶端產生該參數值,要保證在不同請求間唯一,最大不超過64個ASCII字元。 |
| Object | Body | 是 | 請求體。 |
||
| paymentType | String | Body | 否 | prepaid | 執行個體的付費模式。可選值:
|
| version | String | Body | 是 | 6.7_with_X-Pack | 執行個體版本。可選值:
|
| nodeAmount | Integer | Body | 是 | 2 | 執行個體所包含的節點個數。 |
| nodeSpec | Object | Body | 是 | 資料節點配置資訊。 |
|
| disk | Long | Body | 否 | 50 | 節點磁碟大小,單位:GB。 |
| diskType | String | Body | 否 | cloud_ssd | 節點磁碟類型。可選值:
|
| spec | String | Body | 是 | elasticsearch.ic5.2xlarge | 節點規格,規格資訊可通過產品規格查看。 |
| networkConfig | Object | Body | 是 | 網路設定。 |
|
| type | String | Body | 否 | vpc | 網路類型,目前僅支援專用網路。 |
| vpcId | String | Body | 是 | vpc-bp16k1dvzxtmagcva**** | 專用網路ID。 |
| vswitchId | String | Body | 是 | vsw-bp1k4ec6s7sjdbudw**** | 交換器ID。 |
| vsArea | String | Body | 是 | cn-hangzhou-i | 執行個體所在的可用性區域。 |
| paymentInfo | Object | Body | 否 | 訂用帳戶執行個體的付費詳情,建立訂用帳戶執行個體時必填。 |
|
| duration | Long | Body | 否 | 1 | 購買時間長度,支援按月和按年購買。單位:1~9月,1~3年。 |
| pricingCycle | String | Body | 否 | Month | 訂用帳戶單位,可選值:
|
| isAutoRenew | Boolean | Body | 否 | false | 是否開啟自動續約:
|
| autoRenewDuration | Long | Body | 否 | 3 | 自動續約周期,單位:月。isAutoRenew為true時必填,參數值可選範圍與購買頁一致。 |
| description | String | Body | 否 | ls-cn-abc | 執行個體名稱。 |
| resourceGroupId | String | Body | 否 | rg-acfmxxkk2p7**** | 執行個體所在的資源群組ID。 |
返回資料
名稱 |
類型 |
樣本值 |
描述 |
| RequestId | String | 5FFD9ED4-C2EC-4E89-B22B-1ACB6FE***** | 請求ID。 |
| Result | Logstash | 返回結果。 |
樣本
請求樣本
POST /openapi/logstashes?clientToken=5A2CFF0E-5718-45B5-9D4D-70B3FF**** HTTP/1.1
Host:elasticsearch.aliyuncs.com
Content-Type:application/json
{
"paymentType" : "prepaid",
"version" : "6.7_with_X-Pack",
"nodeAmount" : 2,
"nodeSpec" : {
"disk" : 50,
"diskType" : "cloud_ssd",
"spec" : "logstash.n4.small"
},
"networkConfig" : {
"type" : "vpc",
"vpcId" : "vpc-bp16k1dvzxtmagcva****",
"vswitchId" : "vsw-bp1k4ec6s7sjdbudw****",
"vsArea" : "cn-hangzhou-i"
},
"paymentInfo" : {
"duration" : 1,
"pricingCycle" : "Month",
"isAutoRenew" : false,
"autoRenewDuration" : 3
},
"description" : "ls-cn-abc"
}
正常返回樣本
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE*****",
"Result" : [ {
"instanceId" : "ls-cn-n6w1o5jq****",
"version" : "6.7_with_X-Pack",
"description" : "test",
"nodeAmount" : 1,
"paymentType" : "postpaid",
"status" : "active",
"enablePublic" : false,
"nodeSpec" : {
"spec" : "elasticsearch.sn1ne.large",
"disk" : 20,
"diskType" : "cloud_ssd"
},
"networkConfig" : {
"vpcId" : "vpc-bp16k1dvzxtmagcva****",
"vswitchId" : "vsw-bp1k4ec6s7sjdbudw****",
"vsArea" : "cn-hangzhou-i",
"type" : "vpc"
},
"createdAt" : "2020-05-27T01:30:15.947Z",
"updatedAt" : "2020-05-27T01:40:51.333Z",
"commodityCode" : "elasticsearch_logstash_post",
"extendConfigs" : [ ],
"endTime" : 4746268800000,
"clusterTasks" : [ ],
"resourceGroupId" : "rg-acfm2h5vbzd****",
"zoneCount" : 1,
"protocol" : "HTTP",
"zoneInfos" : [ {
"zoneId" : "cn-hangzhou-i",
"status" : "NORMAL"
} ],
"instanceType" : "logstash",
"inited" : true,
"tags" : [ ],
"config" : { },
"endpointList" : [ {
"host" : "172.16.**.**",
"port" : 9600,
"zoneId" : "cn-hangzhou-i"
} ]
} ]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。