CreateLogstash - 创建Logstash实例

更新时间:
复制 MD 格式

调用CreateLogstash,创建一个Logstash实例。

接口说明

在调用接口前,请注意:

  • 请确保在调用该接口前,已充分了解 Logstash 产品的付费方式和价格。详细信息,请参见产品计费。

  • 创建实例需要通过实名认证。详细信息,请参见实名认证。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:CreateLogstash

create

*Logstash

acs:elasticsearch:{#regionId}:{#accountId}:logstashes/*

无 无

请求语法

POST /openapi/logstashes HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

clientToken

string

否

用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一,最大不超过 64 个 ASCII 字符。

5A2CFF0E-5718-45B5-9D4D-70B3FF****

body

object

是

请求体。

7.4.0_with_X-Pack

paymentType

string

否

实例的付费模式。可选值:

  • prepaid:包年包月

  • postpaid:按量付费

prepaid

version

string

是

实例版本。可选值:

  • 6.7_with_X-Pack

  • 7.4_with_X-Pack

6.7_with_X-Pack

nodeAmount

integer

是

实例所包含的节点个数。

2

nodeSpec

object

是

数据节点配置信息。

disk

integer

否

节点磁盘大小,单位:GB。

50

diskType

string

否

节点磁盘类型。可选值:

  • cloud_ssd

  • cloud_efficiency

cloud_ssd

spec

string

是

节点规格,规格信息可通过产品规格查看。

elasticsearch.ic5.2xlarge

networkConfig

object

是

网络配置。

type

string

否

网络类型,目前仅支持专有网络。

vpc

vpcId

string

是

专有网络 ID。

vpc-bp16k1dvzxtmagcva****

vswitchId

string

是

交换机 ID。

vsw-bp1k4ec6s7sjdbudw****

vsArea

string

是

实例所在的可用区。

cn-hangzhou-i

paymentInfo

object

否

包年包月实例的付费详情,创建包年包月实例时必填。

duration

integer

否

购买时长,支持按月和按年购买。单位:1~9 月,1~3 年。

1

pricingCycle

string

否

包年包月单位,可选值:

  • Year:年

  • Month:月

Month

isAutoRenew

boolean

否

是否开启自动续费:

  • true:是

  • false:否

false

autoRenewDuration

integer

否

自动续费周期,单位:月。isAutoRenew 为 true 时必填,参数值可选范围与购买页一致。

3

description

string

否

实例名称。

ls-cn-abc

resourceGroupId

string

否

实例所在的资源组 ID。

rg-acfmxxkk2p7****

返回参数

名称

类型

描述

示例值

object

返回结果对象。

RequestId

string

请求 ID。

5FFD9ED4-C2EC-4E89-B22B-1ACB6FE*****

Result Logstash

返回结果。

示例

正常返回示例

JSON格式

{
  "RequestId": "5FFD9ED4-C2EC-4E89-B22B-1ACB6FE*****",
  "Result": {
    "endpointList": [
      {
        "port": 9200,
        "host": "172.16.xx.xx",
        "zoneId": "cn-hangzhou-i"
      }
    ],
    "status": "NORMAL",
    "description": "ls-cn-abc",
    "resourceGroupId": "rg-acfm2h5vbzd****",
    "endTime": 4749897600000,
    "instanceId": "ls-cn-n6w1o5jq****",
    "config": {
      "key": "[]"
    },
    "createdAt": "2018-07-13T03:58:07.253Z",
    "networkConfig": {
      "vswitchId": "vsw-def",
      "vsArea": "cn-hangzhou-*",
      "vpcId": "vpc-abc",
      "type": "vpc"
    },
    "zoneInfos": [
      {
        "zoneId": "cn-hangzhou-i",
        "status": "NORMAL"
      }
    ],
    "nodeAmount": 2,
    "updatedAt": "2018-07-18T10:10:04.484Z",
    "version": "6.7.0_with_X-Pack",
    "dataNode": true,
    "nodeSpec": {
      "disk": 50,
      "diskType": "cloud_ssd",
      "spec": "logstash.n4.small"
    },
    "paymentType": "postpaid",
    "protocol": "HTTP",
    "tags": [
      {
        "tagValue": "dev",
        "tagKey": "env"
      }
    ],
    "zoneCount": 1
  }
}

错误码

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

变更历史

更多信息,参考变更详情。