GetSecretValue - 获取凭证里信息 - 云原生数据仓库AnalyticDB

获取凭据详细信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
gpdb:GetSecretValue	get	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。说明您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情，包括实例 ID。	gp-xxxxxxxxx
RegionId	string	是	实例所在 Region ID。	cn-beijing
SecretArn	string	否	唯一指定用户创建的 Data API 账号的登录凭证及权限。格式如下：`acs:gpdb:{{region}}:{{accountId}}:secret/{{secretName}}-{{32 digits random string}`。说明和 SecretName 参数二选一。	acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ
SecretName	string	否	用户凭证名称。说明和 SecretArn 参数二选一。	testsecret

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	返回信息。	success
Status	string	状态，取值如下： success：成功。 fail：失败。	success
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
DBInstanceId	string	实例 ID。	gp-xxxxxxxxx
Username	string	用户名。	testacc
Password	string	目标数据库密码。	pwd123
Description	string	描述信息。	test secret
Code	string	错误码。	Secret.NotFound

示例

正常返回示例

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "SecretArn": "acs:gpdb:cn-beijing:1033**:secret/testsecret-eG2AQGRIwQ0zFp4VA7mYL3uiCXTfDQbQ",
  "SecretName": "testsecret",
  "DBInstanceId": "gp-xxxxxxxxx",
  "Username": "testacc",
  "Password": "pwd123",
  "Description": "test secret",
  "Code": "Secret.NotFound"
}

错误码

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