全部产品
Search
文档中心

云原生数据仓库AnalyticDB:GetAccount - GetAccount

更新时间:Dec 20, 2024

获取特定的账号信息。

调试

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

授权信息

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

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

请求参数

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

实例 ID。

说明 支持传入最多 30 个实例 ID 进行批量操作,用英文逗号(,)隔开。
gp-xxxxxxxxx
AccountNamestring

初始账号名称,限制如下:

  • 由小写字母,数字,下划线组成。
  • 以小写字母开头,小写字母或数字结尾。
  • 不能以 gp 开头。
  • 长度为 2~16 个字符。
testuser

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

CA7E4276-E2D5-5F8D-AF06-9EAB3F6C****
AccountStatusstring

数据库账号的状态,取值说明:

  • 0:创建中。
  • 1:使用中。
  • 3:删除中。
1
AccountDescriptionstring

指定修改后的账号描述,要求如下:

  • 以中文、英文字母开头。
  • 不能以http://https://开头。
  • 可以包含中文、英文字符、“_”、“ -”、数字。
  • 长度为 2~256 个字符。
该账号用来登录的实例为DBInstanceId。用来登录的名称为AccountName。
DBInstanceIdstring

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
gp-xxxxxxxxx
AccountNamestring

初始账号名称,限制如下:

  • 由小写字母,数字,下划线组成。
  • 以小写字母开头,小写字母或数字结尾。
  • 不能以 gp 开头。
  • 长度为 2~16 个字符。
testaccount
AccountTypestring

主机账号类型,取值:

  • Normal:普通账号。
  • Admin: 管理员账号。

关于主机账号的权限说明,请参见主机权限说明

Normal

示例

正常返回示例

JSON格式

{
  "RequestId": "CA7E4276-E2D5-5F8D-AF06-9EAB3F6C****",
  "AccountStatus": "1",
  "AccountDescription": "该账号用来登录的实例为DBInstanceId。用来登录的名称为AccountName。",
  "DBInstanceId": "gp-xxxxxxxxx",
  "AccountName": "testaccount",
  "AccountType": "Normal"
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史