describeInstances
描述
查询es实例列表
请求方式
GET
请求地址
https://es.jdcloud-api.com/v1/regions/{regionId}/instances
名称 |
类型 |
是否必需 |
默认值 |
描述 |
regionId |
String |
True |
|
regionId |
请求参数
名称 |
类型 |
是否必需 |
默认值 |
描述 |
pageNumber |
Integer |
False |
|
页码,默认1 |
pageSize |
Integer |
False |
|
分页大小,默认10 |
filters |
Filter[ ] |
False |
|
过滤条件: instanceId -实例Id,精确匹配,支持多个 instanceVersion -实例版本,精确匹配,支持单个 azId -azId,精确匹配,支持单个 instanceName - 实例名称,模糊匹配,支持单个 instanceStatus - 实例状态,精确匹配,支持多个(running:运行,error:错误,creating:创建中,changing:变配中,stop:已停止,processing:处理中) chargeMode - 计费类型,按配置postpaid_by_duration或者包年包月prepaid_by_duration
|
tagFilters |
TagFilter[ ] |
False |
|
标签过滤条件 |
TagFilter
名称 |
类型 |
是否必需 |
默认值 |
描述 |
key |
String |
True |
|
Tag键 |
values |
String[ ] |
True |
|
Tag值 |
Filter
名称 |
类型 |
是否必需 |
默认值 |
描述 |
name |
String |
True |
|
过滤条件的名称 |
operator |
String |
False |
|
过滤条件的操作符,默认eq |
values |
String[ ] |
True |
|
过滤条件的值 |
返回参数
名称 |
类型 |
描述 |
result |
Result |
结果 |
requestId |
String |
本次请求的ID |
Result
名称 |
类型 |
描述 |
instances |
Instance[ ] |
es实例列表 |
totalCount |
Integer |
es实例总数 |
Instance
名称 |
类型 |
描述 |
instanceId |
String |
实例ID |
instanceName |
String |
实例名称 |
instanceVersion |
String |
实例版本,目前支持5.6.9和6.5.4两个版本 |
instanceStatus |
String |
实例状态,running:运行,error:错误,creating:创建中,changing:变配中,stop:已停止,processing:处理中 |
instanceClass |
InstanceClass |
实例的配置信息 |
createTime |
String |
创建时间,遵循ISO8601标准,使用UTC时间,格式为:YYYY-MM-DDTHH:mm:ssZ |
azId |
String |
AZ信息,各AZ编码详见:https://docs.jdcloud.com/cn/jcs-for-elasticsearch/restrictions
|
vpcId |
String |
所属VPC的ID |
subnetId |
String |
所属子网的ID |
charge |
Charge |
计费信息 |
internalEndpoint |
InternalEndpoint |
内网地址 |
tags |
Tag[ ] |
Tag信息 |
dedicatedMaster |
Boolean |
是否开启了专用主节点,true为开启,false为不开启 |
coordinating |
Boolean |
是否开启了协调节点,true为开启,false为不开启 |
Tag
名称 |
类型 |
描述 |
key |
String |
用于标识资源分类的Tag键 |
value |
String |
用于标识资源分类的Tag值 |
InternalEndpoint
名称 |
类型 |
描述 |
esHttpEndpoint |
String |
es http endpoint |
Charge
名称 |
类型 |
描述 |
chargeMode |
String |
支付模式,取值为:prepaid_by_duration,postpaid_by_usage或postpaid_by_duration,prepaid_by_duration表示预付费,postpaid_by_usage表示按用量后付费,postpaid_by_duration表示按配置后付费,默认为postpaid_by_duration |
chargeStatus |
String |
费用支付状态,取值为:normal、overdue、arrear,normal表示正常,overdue表示已到期,arrear表示欠费 |
chargeStartTime |
String |
计费开始时间,遵循ISO8601标准,使用UTC时间,格式为:YYYY-MM-DDTHH:mm:ssZ |
chargeExpiredTime |
String |
过期时间,预付费资源的到期时间,遵循ISO8601标准,使用UTC时间,格式为:YYYY-MM-DDTHH:mm:ssZ,后付费资源此字段内容为空 |
chargeRetireTime |
String |
预期释放时间,资源的预期释放时间,预付费/后付费资源均有此值,遵循ISO8601标准,使用UTC时间,格式为:YYYY-MM-DDTHH:mm:ssZ |
InstanceClass
返回码
返回码 |
描述 |
200 |
OK |
400 |
INVALID_ARGUMENT |