Obtém uma lista de fontes de dados que correspondem às condições de filtro especificadas.
Descrição da operação
Você deve adquirir o DataWorks Basic Edition ou uma edição superior para usar esta operação.
Para chamar esta operação, você deve ter uma das seguintes funções no DataWorks:
Tenant Owner, Workspace Administrator, Deploy, Develop, Visitor, Workspace Owner, O&M, Model Designer, Security Administrator, Data Analyst, OpenPlatform Administrator e Data Governance Administrator
Experimente agora
Testar
Autorização RAM
|
Ação |
Nível de acesso |
Tipo de recurso |
Chave de condição |
Ação dependente |
|
dataworks:ListDataSources |
get |
*All Resource
|
Nenhuma | Nenhuma |
Parâmetros da solicitação
|
Parâmetro |
Tipo |
Obrigatório |
Descrição |
Exemplo |
| ProjectId |
integer |
Sim |
O ID do workspace do DataWorks. Você pode fazer login no console do DataWorks e acessar a página Workspace para consultar o ID. Você deve configurar este parâmetro para especificar o workspace do DataWorks ao qual a operação de API é aplicada. |
17820 |
| Name |
string |
Não |
O nome da fonte de dados. Há suporte para correspondência aproximada pelo nome da fonte de dados. |
test |
| Types |
array |
Não |
Os tipos de fonte de dados. Este parâmetro especifica uma condição de filtro. Você pode especificar vários tipos de fonte de dados. |
|
|
string |
Não |
O tipo de fonte de dados. |
mysql |
|
| EnvType |
string |
Não |
O ambiente no qual as fontes de dados são usadas. Valores válidos:
|
Prod |
| PageNumber |
integer |
Não |
O número da página. Valor padrão: 1. |
1 |
| PageSize |
integer |
Não |
O número de entradas por página. Valor padrão: 10. Valor máximo: 100. |
10 |
| SortBy |
string |
Não |
O campo que você deseja usar para classificar as fontes de dados. Valores válidos:
Valor padrão: CreateTime. |
CreateTime |
| Order |
string |
Não |
A ordem na qual você deseja classificar as fontes de dados. Valores válidos:
Valor padrão: Desc. |
Desc |
| Tags |
string |
Não |
A tag da fonte de dados. Este parâmetro especifica uma condição de filtro.
|
["tag1", "tag2", "tag3"] |
Elementos de resposta
|
Elemento |
Tipo |
Descrição |
Exemplo |
|
object |
Os parâmetros de resposta. |
||
| RequestId |
string |
O ID da solicitação. |
7BE1433F-6D55-5D86-9344-CA6F7DD19B13 |
| PagingInfo |
object |
As informações de paginação. |
|
| TotalCount |
integer |
O número total de entradas que atendem às condições. |
131 |
| PageSize |
integer |
O número de entradas por página. |
10 |
| PageNumber |
integer |
O número da página. |
1 |
| DataSources |
array<object> |
Os grupos de fontes de dados. Cada elemento na matriz indica um grupo de fontes de dados. Cada grupo de fontes de dados contém fontes de dados no ambiente de desenvolvimento (se houver) e no ambiente de produção. |
|
|
array<object> |
As informações sobre o grupo de fontes de dados, incluindo fontes de dados no ambiente de desenvolvimento (se houver) e no ambiente de produção. As fontes de dados no ambiente de desenvolvimento e no ambiente de produção têm o mesmo nome e tipo de fonte de dados, mas IDs de fonte de dados diferentes. |
||
| Name |
string |
O nome da fonte de dados. |
test |
| Type |
string |
O tipo da fonte de dados. |
mysql |
| DataSource |
array<object> |
As fontes de dados. Cada elemento contém as informações de uma única fonte de dados com um ID de fonte de dados exclusivo. |
|
|
object |
As informações sobre a fonte de dados. |
||
| Id |
integer |
O ID da fonte de dados. |
16035 |
| ConnectionProperties |
any |
As configurações de conexão da fonte de dados, incluindo o endereço de conexão, a identidade de acesso e as informações do ambiente. O parâmetro envType especifica o ambiente no qual a fonte de dados é usada. Valores válidos do parâmetro envType:
Os parâmetros que você precisa configurar para a fonte de dados variam de acordo com o modo no qual a fonte de dados é adicionada. Para obter mais informações, consulte Informações de conexão da fonte de dados (ConnectionProperties). |
{ "envType": "Prod", "regionId": "cn-beijing", "instanceId": "hgprecn-cn-x0r3oun4k001", "database": "testdb", "securityProtocol": "authTypeNone", "authType": "Executor", "authIdentity": "1107550004253538" } |
| ConnectionPropertiesMode |
string |
O modo no qual a fonte de dados é adicionada. O modo varia de acordo com o tipo de fonte de dados. Valores válidos:
|
UrlMode |
| Description |
string |
A descrição da fonte de dados. |
test |
| CreateTime |
integer |
A hora em que a fonte de dados foi adicionada. Este valor é um carimbo de data e hora UNIX. |
1648711113000 |
| CreateUser |
string |
O ID do usuário que adiciona a fonte de dados. |
1624387842781448 |
| ModifyTime |
integer |
A hora em que a fonte de dados foi modificada pela última vez. Este valor é um carimbo de data e hora UNIX. |
1648711113000 |
| ModifyUser |
string |
O ID do usuário que modifica a fonte de dados. |
1624387842781448 |
| QualifiedName |
string |
A chave de negócio exclusiva da fonte de dados. Por exemplo, a chave de negócio exclusiva de uma fonte de dados Hologres está no formato ${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}. |
1648711121000:cn-beijing:odps:yongxunQA_beijing_standard |
Exemplos
Resposta de sucesso
JSON formato
{
"RequestId": "7BE1433F-6D55-5D86-9344-CA6F7DD19B13",
"PagingInfo": {
"TotalCount": 131,
"PageSize": 10,
"PageNumber": 1,
"DataSources": [
{
"Name": "test",
"Type": "mysql",
"DataSource": [
{
"Id": 16035,
"ConnectionProperties": "{\n\t\"envType\": \"Prod\",\n\t\"regionId\": \"cn-beijing\",\n \"instanceId\": \"hgprecn-cn-x0r3oun4k001\",\n \"database\": \"testdb\",\n \"securityProtocol\": \"authTypeNone\",\n \"authType\": \"Executor\",\n \"authIdentity\": \"1107550004253538\"\n}",
"ConnectionPropertiesMode": "UrlMode",
"Description": "test ",
"CreateTime": 1648711113000,
"CreateUser": "1624387842781448",
"ModifyTime": 1648711113000,
"ModifyUser": "1624387842781448",
"QualifiedName": "1648711121000:cn-beijing:odps:yongxunQA_beijing_standard"
}
]
}
]
}
}Códigos de erro
Consulte Códigos de Erro para uma lista completa.
Notas de versão
Consulte Notas de Versão para uma lista completa.