CreateRole - 创建角色--ByteHouse 企业版-火山引擎

文档中心

导航

CreateRole - 创建角色

最近更新时间：2024.10.09 17:05:55首次发布时间：2024.10.09 17:01:19

创建角色

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	CreateRole	要执行的操作，取值：CreateRole。
Version	String	是	2024-08-31	API的版本，取值：2024-08-31。
Name	String	是	role1	角色名称
Description	String	否	description	描述信息
ClusterID	Integer	是	123456	集群id
Users	Array of Object	否	[ { "Username": "user1", "AdminOption": true } ]	授予用户信息

返回参数

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

参数	类型	示例值	描述
Message	String		top响应信息
Data	Object	{ "Message": "create role successfully", "Role": { "ID": 123456, "Name": "system_admin", "Description": "MwrIZqDiy", "IsDefault": false, "ClusterID": 306, "AccountID": 898, "ClusterName": "cluster", "GrantUsers": [], "CreatedAt": 1721294525980, "UpdatedAt": "1721294525980", "CreatedBy": "dba", "UpdatedBy": "dTa" } }	返回数据

请求示例

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

{
  "Name": "role1",
  "Description": "description",
  "ClusterID": 123456,
  "Users": [
    {
      "Username": "user1",
      "AdminOption": true
    }
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240929142824215140052248F4D25D",
    "Action": "CreateRole",
    "Version": "2024-08-31",
    "Service": "bytehouse_ce",
    "Region": "cn-beijing"
  },
  "Result": {
    "Message": "",
    "Data": {
      "Message": "create role successfully",
      "Role": {
        "ID": 123456,
        "Description": "description",
        "IsDefault": true,
        "Name": "system_admin",
        "ClusterID": 123456,
        "AccountID": 123456,
        "ClusterName": "cluster",
        "CreatedAt": 1721294525980,
        "UpdatedAt": 1721294525980,
        "CreatedBy": "dba",
        "UpdatedBy": "dba",
        "GrantUsers": []
      }
    }
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	Bad Request	api service received invalid request format	参数错误
401	SignatureNotMatch	The request signature provided is incorrect.
500	InternalError	The request has failed due to an unknown error.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server.