调用CreateSecret通过用户名密码创建实例访问凭证-云原生数据仓库AnalyticDB-阿里云-云原生数据仓库AnalyticDB(AnalyticDB)-阿里云帮助中心

通过用户名密码创建访问实例的凭证。

调试

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

调试

授权信息

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

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

gpdb:CreateSecret

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	否	实例 ID。说明您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 版实例的详情，包括实例 ID。	gp-xxxxxxxxx
WorkspaceId	string	否	多数据库实例组成的 Workspace 的 Id。此参数和 DBInstanceId 参数不能同时为空，当和 DBInstanceId 同时指定时以此参数为准。	gp-ws-*****
RegionId	string	是	实例所在地域 ID。	cn-beijing
Username	string	是	数据库访问用户名。说明限制：由小写字母，数字，下划线组成，并且以小写字母开头。长度不能超过 64 个字符。	testacc
Password	string	是	数据库访问密码。	pwd123
Description	string	否	凭据的描述信息。长度不能超过 255 个字符。	test
SecretName	string	否	凭据名称。由字母、数字和下划线组成，长度为 1-16 个字符。为空时则使用 Username 参数作为 SecretName。	testsecret
TestConnection	boolean	否	是否通过用户名和密码检测实例链接是否正常。	true

返回参数

名称	类型	描述	示例值
	object
Message	string	接口返回详细信息。	Successful
RequestId	string	请求 ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
SecretArn	string	唯一指定用户创建的 Data API 账号的登录凭证及权限。格式如下：`acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}`。	acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ
SecretName	string	凭证的名称。	testsecret
Status	string	状态，取值如下： success：成功。 fail：失败。	success

示例

正常返回示例

JSON格式

{
  "Message": "Successful",
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "SecretArn": "acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ",
  "SecretName": "testsecret",
  "Status": "success"
}

错误码

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

变更历史

更多信息，参考变更详情。