DeployInstanceSDG - 部署SDG到实例

更新时间:
复制 MD 格式

部署SDG到计算实例。

调试

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

调试

授权信息

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

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

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

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

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

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

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

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

操作

访问级别

资源类型

条件关键字

关联操作

ens:DeployInstanceSDG

none

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

InstanceIds

array

实例的编号列表。参数为一个带有格式的 JSON 数组,最多 100 个 ID。

string

AIC 实例 ID。

["aic-1", "aic-2", "aic-3"]

SDGId

string

SDG 的 ID。

sdg-xxxx

DeploymentType

string

SDG 部署类型,取值 shared 表示读写分离共享部署,SDG 内容只读,数据更新内容写入实例本地。

此参数实际为必填项,当前仅支持 shared;未提供时服务返回 Parameter.Invalid。

枚举值:

  • shared :

    读写分离共享部署

shared

DiskType

string

生产的共享盘磁盘类型:

  • standard(标准云盘)。

  • rbd(rbd 云盘)。

说明
  • 不指定共享盘磁盘类型时默认生成标准云盘。

  • 仅母盘类型为 rbd 时支持生成 rbd 共享盘。

standard

DiskAccessProtocol

string

云盘访问协议类型:

  • iscsi:标准云盘默认协议,rbd 云盘和标准云盘都支持该协议。

  • rbd:rbd 云盘默认协议,只有 rbd 云盘支持该挂载协议。

iscsi

返回参数

名称

类型

描述

示例值

object

Data

object

返回 Data 对象。

Message

string

响应消息,若成功请求为 success。

success

Result

object

同步请求执行结果。

FailedCount

integer

失败数量。

0

FailedItems

array<object>

失败详情列表。

object

ErrMessage

string

错误信息。

sdg not found

InstanceId

string

实例 ID。

aic-xxxxx-0

SuccessCount

integer

成功数量。

1

Success

boolean

请求是否全部成功。取值说明如下:

  • true:全部成功。

  • false:存在失败任务。

true

RequestId

string

请求 ID。

125B04C7-3D0D-4245-AF96-14E3758E3F06

示例

正常返回示例

JSON格式

{
  "Data": {
    "Message": "success",
    "Result": {
      "FailedCount": 0,
      "FailedItems": [
        {
          "ErrMessage": "sdg not found",
          "InstanceId": "aic-xxxxx-0"
        }
      ],
      "SuccessCount": 1
    },
    "Success": true
  },
  "RequestId": "125B04C7-3D0D-4245-AF96-14E3758E3F06"
}

错误码

HTTP status code

错误码

错误信息

描述

400 Interface.Call.Error The interface call error 接口调用出错
400 Interface.Call.Failed %s. 请求失败
400 Parameter.Invalid The parameter is invalid. Please check your parameters and try it again. 参数不合法
400 NoPermission Permission denied.
400 InvalidParameter.%s The specified field %s invalid. Please check it again.

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

变更历史

更多信息,参考变更详情