CreateLogstash - 检索分析服务Elasticsearch版

在调用接口前，请注意：

请确保在调用该接口前，已充分了解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	实例的付费模式。可选值： prepaid：包年包月 postpaid：按量付费
version	String	Body	是	6.7_with_X-Pack	实例版本。可选值： 6.7_with_X-Pack 7.4_with_X-Pack
nodeAmount	Integer	Body	是	2	实例所包含的节点个数。
nodeSpec	Object	Body	是		数据节点配置信息。
disk	Long	Body	否	50	节点磁盘大小，单位：GB。
diskType	String	Body	否	cloud_ssd	节点磁盘类型。可选值： cloud_ssd cloud_efficiency
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	包年包月单位，可选值： Year：年 Month：月
isAutoRenew	Boolean	Body	否	false	是否开启自动续费： true：是 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"
    } ]
  } ]
}

错误码

访问错误中心查看更多错误码。