ListClusterUserGroups - 获取集群用户组列表--E-MapReduce-火山引擎

文档中心

立即注册

导航

E-MapReduce

ListClusterUserGroups - 获取集群用户组列表

最近更新时间：2024.07.24 15:19:32首次发布时间：2024.07.24 15:19:32

获取集群用户组列表

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	ListClusterUserGroups	要执行的操作，取值：ListClusterUserGroups。
Version	String	是	2023-08-15	API的版本，取值：2023-08-15。
ClusterId	String	是	emr-xxx	集群ID
UserGroupName	String	否	emr_usergroup	用户组名称
Keyword	String	否	emr	关键字，用户组名称模糊匹配

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Items	Array of Object	[ { "ClusterId": "emr-xxx", "UserGroupName": "emr_usergroup", "Description": "emr用户组" } ]	用户组基础信息

请求示例

POST /?Action=ListClusterUserGroups&Version=2023-08-15 HTTP/1.1
Host: open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20240701T021027Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240701/cn-beijing/emr/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "ClusterId": "emr-xxx",
  "UserGroupName": "emr_usergroup"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240708101656249245174165FBBBAE",
    "Action": "ListClusterUserGroups",
    "Version": "2023-08-15",
    "Service": "emr",
    "Region": "cn-beijing"
  },
  "Result": {
    "Items": [
      {
        "ClusterId": "emr-xxx",
        "UserGroupName": "emr_usergroup",
        "Description": "emr用户组"
      }
    ]
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidClusterId	cluster id {clusterId} not found	集群不存在