DeploySDG - 部署SDG

调用DeploySDG部署SDG。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ens:DeploySDG
*全部资源
*

请求参数

名称类型必填描述示例值
InstanceIdsarray

要部署 SDG 的设备资源 ID 列表。支持批量部署,最多一次部署 100 个 Instance。

string

要部署 SDG 的设备资源 ID 列表。支持批量部署,最多一次部署 100 个 Instance。

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

使用 SDGId 创建云盘,并挂载到 InstanceId。

sdg-xxxxx
DeploymentTypestring

SDG 部署类型,包括:

  • common:(默认)可读写部署,数据更新内容会写入云盘。
  • overlay:读写分离部署,SDG 内容只读,数据更新内容写入实例本地。
common

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

A331CA96-3948-4BD2-B067-F6174F5C17EA
Dataobject

返回 Data 对象。

Messagestring

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

success
Resultobject

任务结果。

FailedCountlong

失败任务数。

0
FailedItemsarray<object>

失败任务详情列表

FailedItemobject

失败任务详情

ErrMessagestring

错误信息。

sdg not found
InstanceIdstring

实例 ID。

aic-xxxxx-0
SuccessCountlong

成功数量。

1
Successboolean

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

  • true:全部成功。
  • false:存在失败任务。
true

示例

正常返回示例

JSON格式

{
  "RequestId": "A331CA96-3948-4BD2-B067-F6174F5C17EA",
  "Data": {
    "Message": "success",
    "Result": {
      "FailedCount": 0,
      "FailedItems": [
        {
          "ErrMessage": "sdg not found",
          "InstanceId": "aic-xxxxx-0"
        }
      ],
      "SuccessCount": 1
    },
    "Success": true
  }
}

错误码

HTTP status code错误码错误信息描述
400Interface.Call.ErrorThe interface call error接口调用出错
400Interface.Call.Failed%s.请求失败
400Parameter.InvalidThe parameter is invalid. Please check your parameters and try it again.参数不合法
400NoPermissionPermission denied.没有足够的权限,请联系云账号管理员授予您相应权限。
400InvalidParameter.%sThe specified field %s invalid. Please check it again.-

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

变更历史

变更时间变更内容概要操作
2024-03-22OpenAPI 错误码发生变更查看变更详情
2024-02-28OpenAPI 错误码发生变更查看变更详情
2023-11-23OpenAPI 入参发生变更查看变更详情