Skip to main content

Query Data Source Owner

Use this API to query the Owner configuration of a data source and selected databases.

Request URL: /openapi/v1/datasource/owner/query

Request Method: GET

Request Parameters

ParameterTypeRequiredDescriptionExample
datasourceIdStringYesData source ID. Obtain it from List Data Sources.ds-example123
databaseListArrayNoDatabase names whose Owner configuration you want to query. Obtain database names from List Databases. Repeat the databaseList query parameter to query multiple databases.app_db, audit_db

Request Example

GET /openapi/v1/datasource/owner/query?datasourceId=ds-example123&databaseList=app_db&databaseList=audit_db

Response Parameters

ParameterTypeDescriptionExample
successBoolWhether the API call succeeded.true
requestIdStringRequest ID.request-example
dataObjectOwner query result.{...}
└ownerStringData source Owner. Omitted when the data source has no Owner.<Owner>
└ownerTypeStringData source Owner type. Values: account and role. Omitted when the data source has no Owner.account
└databaseOwnersArrayConfigured database Owners. Returns an empty array when no database Owner is configured.[]
  └ownerStringDatabase Owner.<Owner>
  └ownerTypeStringDatabase Owner type. Values: account and role.account
errorCodeStringError code. Returned when the call fails.INVALID_PARAMETER
messageStringError message. Returned when the call fails.Invalid parameter

Successful Response

Data source with an Owner:

{
"success": true,
"requestId": "request-example",
"data": {
"owner": "<Owner>",
"ownerType": "account",
"databaseOwners": []
}
}

Data source without an Owner:

{
"success": true,
"requestId": "request-example",
"data": {
"databaseOwners": []
}
}