重启实例或者节点 - RestartinganInstanceoraNode
功能介绍
重启实例或节点的数据库服务。
接口约束
- 实例重启支持如下数据库实例：
- GeminiDB Cassandra
- GeminiDB Mongo
- GeminiDB Influx
- GeminiDB Redis
- 实例状态非“normal”时，不允许重启实例。
- 节点重启支持如下数据库实例:
- GeminiDB Redis云原生部署模式集群
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
授权项
访问级别
资源类型（*为必须）
条件键
别名
依赖的授权项
gaussdbfornosql:instance:restart
Write
instance *
- g:ResourceTag/<tag-key>
- g:EnterpriseProjectId
nosql:instance:restart
-
URI
POST /v3/{project_id}/instances/{instance_id}/restart
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释： 租户在某一region下的project ID。获取方法请参见获取项目ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
instance_id |
是 |
String |
参数解释： 实例ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
node_id |
否 |
String |
参数解释： 待重启的节点ID。 约束限制： 仅GeminiDB Redis云原生部署模式集群实例支持传入节点ID重启对应节点。 取值范围： 节点ID。 不传则重启整个实例。 默认取值： 不涉及。 |
|
is_delayed |
否 |
Boolean |
参数解释： 是否延迟到可维护时间窗进行重启。 约束限制： 不涉及。 取值范围：
默认取值： false。 |
|
is_parallel |
否 |
Boolean |
参数解释： 是否并行重启。 约束限制： GeminiDB Cassandra不支持。 取值范围：
默认取值： false。 |
响应参数
状态码： 202
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
job_id |
String |
参数解释： 任务ID。 取值范围： 不涉及。 |
请求示例
- 立即重启实例944bdc55da6c4b33b260b34185ac86bein13。
POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/944bdc55da6c4b33b260b34185ac86bein13/restart - 延迟重启实例534bsc43da6c3356b260g44185ac86bein12。
POST https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/534bsc43da6c3356b260g44185ac86bein12/restart - 请求体样例
{ "is_delayed" : true }
响应示例
状态码： 202
Accepted
{
"job_id" : "f85104b5-4a9c-4e0f-9505-fc5409d8f7ae"
}
状态码
请参见状态码。
错误码
请参见错误码。
