扩容集群-ExpandCluster

功能介绍

对MRS集群进行扩容。

接口约束

无

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和受限项。

如果使用身份策略授权，需具备如下身份策略权限。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
mrs:cluster:resizeNodes	Write	cluster *	g:ResourceTag/<tag-key> g:EnterpriseProjectId	mrs:cluster:resize	-

URI

POST /v2/{project_id}/clusters/{cluster_id}/expand

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目编号。约束限制：不涉及取值范围：只能由英文字母和数字组成，且长度为[1-64]个字符。默认取值：不涉及
cluster_id	是	String	参数解释：集群ID。约束限制：不涉及取值范围：只能由英文字母、数字以及“_”和“-”组成，且长度为[1-64]个字符。默认取值：不涉及

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
node_group_name	是	String	参数解释：节点组名称。约束限制：不涉及取值范围：只能由英文字母、数字以及“_”和“-”组成，且长度为[1-64]个字符。默认取值：不涉及
count	是	Integer	参数解释：扩容节点数量。约束限制：不涉及取值范围：不涉及默认取值：不涉及
skip_bootstrap_scripts	否	Boolean	参数解释：扩容时是否在新增节点上跳过执行创建集群时指定的引导操作。约束限制：不涉及取值范围： true：跳过执行创建集群时指定的引导操作。 false：不跳过执行创建集群时指定的引导操作。默认取值： true
scale_without_start	否	Boolean	参数解释：扩容后是否选择不启动扩容节点上的组件。约束限制：不涉及取值范围： true：扩容后不启动组件。 false：扩容后启动组件。默认取值： false

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
result	String	参数解释：请求操作结果，succeeded为操作成功，failed为操作失败。非包周期节点组扩容请求下发成功时，会包含该字段且内容为success。约束限制：不涉及取值范围： succeeded：操作成功 failed为操作失败默认取值：不涉及
order_id	String	参数解释：订单ID。对包周期节点组进行扩容时，会返回本次扩容产生的订单ID，需要客户到订单支付页面进行自主支付才能真正触发扩容。约束限制：不涉及取值范围：不涉及默认取值：不涉及

请求示例

在节点组node_group_1上扩容1个节点，默认跳过引导操作，默认启动组件。

/v2/ff8080828997cb24018a1b2db3440b80/clusters/f7f45c04-4303-411c-9b71-d2cb730dd162/expand 

 { 
   "node_group_name" : "node_group_1", 
   "count" : "1" 
 }

在节点组node_group_1上扩容1个节点，不跳过引导操作，不启动组件。

/v2/ff8080828997cb24018a1b2db3440b80/clusters/f7f45c04-4303-411c-9b71-d2cb730dd162/expand 
  
 { 
   "node_group_name" : "node_group_1", 
   "count" : "1", 
   "skip_bootstrap_scripts" : false, 
   "scale_without_start" : true 
 }