文档

DescribeGroupStruct - 获取分组结构

更新时间:

获取分组结构。

调试

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

授权信息

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

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

请求参数

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

设置请求和接收消息的语言类型,默认为 zh。取值:

  • zh:中文
  • en:英文
zh

返回参数

名称类型描述示例值
object

返回对象。

RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

9FBC6E47-7508-58C9-9E76-528E118C****
GroupIdlong

资产分组的 ID。

958****
GroupNamestring

服务器分组名称。

TestGroupName
MachineNuminteger

服务器的数量。

30
GroupIndexinteger

排序序号。

1
GroupFatherinteger

分组父节点。

958****
GroupLevelinteger

应用分组的级别。

2
GroupFlaginteger

服务器分组类型。取值:

  • 0:默认分组
  • 1:其他分组
0
Groupsarray

下一级分组集合。

string

字段同上一级。

[ { "groupName": "testfuxian", "groupFather": 0, "groupId": 11501234, "childGroups": [], "groupLevel": 1, "groupIndex": 100, "groupFlag": 1 }, { "groupName": "testfuxian", "groupFather": 0, "groupId": 11501234, "childGroups": [], "groupLevel": 1, "groupIndex": 100, "groupFlag": 1 } ]

示例

正常返回示例

JSON格式

{
  "RequestId": "9FBC6E47-7508-58C9-9E76-528E118C****",
  "GroupId": 0,
  "GroupName": "TestGroupName",
  "MachineNum": 30,
  "GroupIndex": 1,
  "GroupFather": 0,
  "GroupLevel": 2,
  "GroupFlag": 0,
  "Groups": [
    "[\n\t{\n\t\t\"groupName\": \"testfuxian\",\n\t\t\"groupFather\": 0,\n\t\t\"groupId\": 11501234,\n\t\t\"childGroups\": [],\n\t\t\"groupLevel\": 1,\n\t\t\"groupIndex\": 100,\n\t\t\"groupFlag\": 1\n\t},\n\t{\n\t\t\"groupName\": \"testfuxian\",\n\t\t\"groupFather\": 0,\n\t\t\"groupId\": 11501234,\n\t\t\"childGroups\": [],\n\t\t\"groupLevel\": 1,\n\t\t\"groupIndex\": 100,\n\t\t\"groupFlag\": 1\n\t}\n]"
  ]
}

错误码

HTTP status code错误码错误信息描述
403NoPermissioncaller has no permission当前操作未被授权,请联系主账号在RAM控制台进行授权后再执行操作。
500ServerErrorServerError服务故障,请稍后重试!

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈