Queries a list of data sources.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ProjectId |
integer |
Yes |
The ID of the workspace to which the data source belongs. You can call the ListProjects operation to query the ID. |
76086 |
| Name |
string |
No |
The name of the data source that you want to query. |
abc |
| ConnectionType |
string |
No |
The type of the data source. Valid values:
|
rds |
| SubType |
string |
No |
The subtype of the data source. This parameter is used in scenarios where a type includes subtypes. The following type and subtypes are supported:
|
mysql |
| Status |
string |
No |
The status of the data source. Valid values:
|
1 |
| EnvType |
integer |
No |
The environment in which the data source is used. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment. |
1 |
| PageSize |
integer |
No |
The number of entries per page. Default value: 10. Maximum value: 100. |
10 |
| PageNumber |
integer |
No |
The page number. Pages start from page 1. |
1 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| HttpStatusCode |
integer |
The HTTP status code. |
200 |
| RequestId |
string |
The request ID. |
0bc14115159376359**** |
| Success |
boolean |
Indicates whether the request was successful. |
true |
| Data |
object |
The query results for data sources that are returned on multiple pages. |
|
| PageNumber |
integer |
The page number. |
1 |
| PageSize |
integer |
The number of entries per page. Default value: 10. Maximum value: 100. |
20 |
| TotalCount |
integer |
The total number of data sources returned. |
3 |
| Connections |
array<object> |
The data sources. |
|
|
object |
|||
| Status |
integer |
The status of the data source. Valid values:
|
1 |
| ConnectionType |
string |
The type of the data source. Valid values:
|
mysql |
| ProjectId |
integer |
The ID of the workspace with which the data source is associated. |
123 |
| SubType |
string |
The subtype of the data source. This parameter is used in scenarios where a type includes subtypes. The following type and subtypes are supported:
|
mysql |
| GmtModified |
string |
The time when the data source was last modified. Example: Mar 17, 2021 4:09:32 PM. |
Mar 17, 2021 4:09:32 PM |
| EnvType |
integer |
The environment in which the data source is used. Valid values:
|
1 |
| ConnectStatus |
integer |
The status of the data source. Valid values:
|
1 |
| Sequence |
integer |
The field that is used to sort data sources. Data sources are sorted in descending order based on the value of this parameter. |
300 |
| Description |
string |
The description of the data source. |
a connection |
| GmtCreate |
string |
The time when the data source was created. Example: Mar 17, 2021 4:09:32 PM. |
Mar 17, 2021 4:09:32 PM |
| DefaultEngine |
boolean |
Indicates whether the compute engine that is associated with the data source is the default compute engine used by data sources of the same type. |
false |
| Shared |
boolean |
Indicates whether the data source is a shared data source. |
false |
| Operator |
string |
The ID of the Alibaba Cloud account that is used to last modify the data source. |
193543050**** |
| Name |
string |
The name of the data source. |
abc |
| Content |
string |
The details of the data source. Examples of details of some common data sources:
|
{\"database\":\"xxx\",\"instanceName\":\"xxx\",\"password\":\"xxx\",\"rdsOwnerId\":\"xxx\",\"tag\":\"rds\",\"username\":\"xxx\"} |
| Id |
integer |
The data source ID. |
1 |
| BindingCalcEngineId |
integer |
The ID of the compute engine with which the data source is associated. |
123 |
| TenantId |
integer |
The tenant ID. |
1234567 |
Examples
Success response
JSON format
{
"HttpStatusCode": 200,
"RequestId": "0bc14115159376359****",
"Success": true,
"Data": {
"PageNumber": 1,
"PageSize": 20,
"TotalCount": 3,
"Connections": [
{
"Status": 1,
"ConnectionType": "mysql",
"ProjectId": 123,
"SubType": "mysql",
"GmtModified": "Mar 17, 2021 4:09:32 PM",
"EnvType": 1,
"ConnectStatus": 1,
"Sequence": 300,
"Description": "a connection",
"GmtCreate": "Mar 17, 2021 4:09:32 PM",
"DefaultEngine": false,
"Shared": false,
"Operator": "193543050****",
"Name": "abc",
"Content": "{\\\"database\\\":\\\"xxx\\\",\\\"instanceName\\\":\\\"xxx\\\",\\\"password\\\":\\\"xxx\\\",\\\"rdsOwnerId\\\":\\\"xxx\\\",\\\"tag\\\":\\\"rds\\\",\\\"username\\\":\\\"xxx\\\"}",
"Id": 1,
"BindingCalcEngineId": 123,
"TenantId": 1234567
}
]
}
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | Invalid.Tenant.ConnectionNotExists | The connection does not exist. | The connection does not exist. |
| 400 | Invalid.Tenant.ProjectNotExists | The project does not exist. | The project does not exist. |
| 400 | Invalid.Tenant.UserNotInProject | The user is not in the project. | The user is not in the project. |
| 403 | Invalid.Tenant.UserIsNotProjectOwnerOrAdmin | The user is not a project administrator or owner. | The user is not a project administrator or owner. |
| 403 | Invalid.Tenant.UserNotInTenant | The user is not in tenant. | The user is not in tenant. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.