DescribeJDBCDataSource - 获取JDBC数据源配置信息

更新时间:

获取jdbc数据源配置信息。

调试

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

授权信息

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

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

请求参数

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

实例 ID。

gp-xxx
DataSourceIdstring

数据源 id

123

返回参数

名称类型描述示例值
object
DataSourceIdstring

服务 Id。

123
RequestIdstring

请求 ID。

B4CAF581-2AC7-41AD-8940-D56DF7AADF5B
DataSourceNamestring

服务名称。

hdfs_pxf
DataSourceDescriptionstring

服务描述,最大长度为 256 字符。

mysql data source config
DataSourceStatusstring

服务状态位,取值:

  • 初始化中 Init

  • 运行中 Running

  • 异常 Exception

Running
StatusMessagestring

服务状态信息,例如异常情况,则显示异常原因。正常 Running 状态下空值。

""
CreateTimestring

创建时间。

2019-09-08T16:00:00Z
DataSourceTypestring

数据源类型。

mysql
JDBCConnectionStringstring

JDBC 连接串。

jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin
JDBCUserNamestring

用户名。

testuser
JDBCPasswordstring

密码。

testpasswd
ModifyTimestring

最后修改时间。

2024-09-04T02:27:55Z
ExternalDataServiceIdstring

外部数据服务 id。

2989

示例

正常返回示例

JSON格式

{
  "DataSourceId": "123",
  "RequestId": "B4CAF581-2AC7-41AD-8940-D56DF7AADF5B",
  "DataSourceName": "hdfs_pxf",
  "DataSourceDescription": "mysql data source config",
  "DataSourceStatus": "Running",
  "StatusMessage": "\"\"",
  "CreateTime": "2019-09-08T16:00:00Z",
  "DataSourceType": "mysql",
  "JDBCConnectionString": "jdbc:mysql://rm-xxx.mysql.rds.aliyuncs.com:3306/testadmin",
  "JDBCUserName": "testuser",
  "JDBCPassword": "testpasswd",
  "ModifyTime": "2024-09-04T02:27:55Z",
  "ExternalDataServiceId": "2989"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-08-20OpenAPI 返回结构发生变更查看变更详情