ListDataSources - - Centre de documentation Alibaba Cloud

Débogage

OpenAPI Explorer calcule automatiquement la valeur de signature. Nous vous recommandons d’appeler cette opération dans OpenAPI Explorer. OpenAPI Explorer génère dynamiquement des exemples de code pour différents SDK.

Paramètres de requête

Paramètre	Type	Obligatoire	Exemple	Description
Action	String	Oui	ListDataSources	Opération à effectuer. Définissez la valeur sur ListDataSources.
ProjectId	Long	Oui	1	ID de l’espace de travail DataWorks auquel appartiennent les sources de données. Appelez l’opération ListProjects pour obtenir l’ID.
Name	String	Non	test	Nom de la source de données à interroger.
DataSourceType	String	Non	rds	Type de la source de données. Valeurs possibles : odps mysql rds oss sqlserver polardb oracle mongodb emr postgresql analyticdb_for_mysql hybriddb_for_postgresql holo
SubType	String	Non	mysql	Sous-type de la source de données. Ce paramètre n’est effectif que si le paramètre DataSourceType est défini sur rds. Si DataSourceType est défini sur rds, ce paramètre peut prendre les valeurs mysql, sqlserver ou postgresql.
Status	String	Non	ENABLED	Statut de la source de données. Valeurs possibles : ENABLED DISABLED
EnvType	Integer	Non	1	Environnement d’utilisation de la source de données. Valeurs possibles : 0 et 1. La valeur 0 correspond à l’environnement de développement. La valeur 1 correspond à l’environnement de production.
PageSize	Integer	Non	10	Nombre d’entrées par page. Valeur maximale : 100. Valeur par défaut : 10.
PageNumber	Integer	Non	1	Numéro de page. La valeur doit être un entier supérieur ou égal à 1.

Paramètres de réponse

Paramètre	Type	Exemple	Description
HttpStatusCode	Integer	200	Code d’état HTTP renvoyé.
RequestId	String	0bc14115159376359****	ID de la requête.
Success	Boolean	true	Indique si la requête a abouti.
Data	Object		Résultat de la requête.
PageNumber	Integer	1	Numéro de page.
PageSize	Integer	20	Nombre d’entrées par page. Valeur maximale : 100. Valeur par défaut : 10.
TotalCount	Integer	233	Nombre total de sources de données.
DataSources	Array of DataSources		Sources de données.
Status	Integer	1	Statut de la source de données. Valeurs possibles : 1 : la source de données est accessible. 2 : la source de données est inaccessible.
ProjectId	Integer	123	ID de l’espace de travail auquel appartient la source de données.
SubType	String	mysql	Sous-type de la source de données. Ce paramètre n’est effectif que si DataSourceType est défini sur rds. Si DataSourceType est défini sur rds, ce paramètre peut prendre les valeurs mysql, sqlserver ou postgresql.
GmtModified	String	Mar 17, 2021 4:09:32 PM	Date et heure de la dernière modification de la source de données. Exemple : Mar 17, 2021 4:09:32 PM.
EnvType	Integer	1	Environnement d’utilisation de la source de données. Valeurs possibles : 0 : environnement de développement 1 : environnement de production
ConnectStatus	Integer	1	Statut de la source de données. Valeurs possibles : 1 : la source de données est accessible. 2 : la source de données est inaccessible.
Sequence	Integer	300	Numéro de séquence de la source de données. Le tri des sources de données s’effectue par ordre décroissant selon la valeur de ce paramètre.
Description	String	a connection	Description de la source de données.
DataSourceType	String	rds	Type de la source de données. Valeurs possibles : odps mysql rds oss sqlserver polardb oracle mongodb emr postgresql analyticdb_for_mysql hybriddb_for_postgresql holo
GmtCreate	String	Mar 17, 2021 4:09:32 PM	Date et heure de création de la source de données. Exemple : Mar 17, 2021 4:09:32 PM.
DefaultEngine	Boolean	false	Indique si l’instance de moteur de calcul associée à la source de données est le moteur de calcul par défaut utilisé par les sources de données du même type.
Shared	Boolean	false	Indique si la source de données est partagée.
Operator	String	193543050****	ID du compte Alibaba Cloud ayant effectué la dernière modification de la source de données.
Name	String	abc	Nom de la source de données.
Content	String	{"pubEndpoint":"http://service.cn.maxcompute.aliyun.com/api","accessId":"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC","securityToken":null,"endpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","accessKey":"***","name":"PRE_PROJECT_A_engine","project":"PRE_PROJECT_A","vpcEndpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","region":"cn-shanghai","authType":"2"}	Chaîne de connexion de données. La valeur de ce paramètre est au format JSON. Exemples de chaînes de connexion pour les sources de données courantes : MaxCompute `json { "pubEndpoint": "http://service.cn.maxcompute.aliyun.com/api", "accessId": "xxxxxxx", "securityToken": null, "endpoint": "http://service.cn.maxcompute.aliyun-inc.com/api", "accessKey": "*", "name": "PRE_PROJECT_A_engine", "project": "PRE_PROJECT_A", "vpcEndpoint": "http://service.cn.maxcompute.aliyun-inc.com/api", "region": "cn-shanghai", "authType": "2" }` mysql `json { "configType": "1", "database": "mysql_d111b", "instanceName": "rm-xxxxxx", "password": "", "rdsOwnerId": "12133xxxxxx", "tag": "rds", "username": "mysql_db111" }` sqlserver `json { "configType": "1", "jdbcUrl": "jdbc:sqlserver://rm-xxxxx.sqlserver.rds.aliyuncs.com:1433;DatabaseName=sqlserver_db1", "password": "", "tag": "public", "username": "sqlserver_db111" }` oss `json { "accessId": "LTAINbR9Uxxxx", "accessKey": "", "bucket": "bigxxx1223", "configType": "1", "endpoint": "http://oss-cn-hangzhou.aliyuncs.com", "tag": "public" }` postgresql `json { "configType": "1", "database": "cdp_xxx", "instanceName": "rm-xxxx", "password": "", "rdsOwnerId": "121xxxxx", "tag": "rds", "username": "cdp_xxx" }` ads `json { "configType": "1", "password": "*", "schema": "ads_demo", "tag": "public", "url": "ads-xxx-xxxx.cn-hangzhou-1.ads.aliyuncs.com:3029", "username": "lslslsls" }`
Id	Long	1	ID de la source de données.
BindingCalcEngineId	Long	123	ID de l’instance de moteur de calcul associée à la source de données.
TenantId	Long	1234567	ID du locataire.

Exemples

Exemple de requête

http(s)://[Endpoint]/?Action=ListDataSources
&Name=test
&ProjectId=1
&RegionId=cn-shanghai
&<Common request parameters>

Exemple de réponse en cas de succès

Format XML

HTTP/1.1 200 OK
Content-Type:application/xml

<RequestId>0bc14115159376359****</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<Data>
    <TotalCount>233</TotalCount>
    <PageSize>20</PageSize>
    <PageNumber>1</PageNumber>
    <DataSources>
        <Status>1</Status>
        <Operator>193543050****</Operator>
        <ConnectStatus>1</ConnectStatus>
        <SubType>mysql</SubType>
        <Description>a connection</Description>
        <BindingCalcEngineId>123</BindingCalcEngineId>
        <ProjectId>123</ProjectId>
        <GmtModified>Mar 17, 2021 4:09:32 PM</GmtModified>
        <Sequence>300</Sequence>
        <Shared>false</Shared>
        <EnvType>1</EnvType>
        <Name>abc</Name>
        <DefaultEngine>false</DefaultEngine>
        <TenantId>1234567</TenantId>
        <GmtCreate>Mar 17, 2021 4:09:32 PM</GmtCreate>
        <Content>{"pubEndpoint":"http://service.cn.maxcompute.aliyun.com/api","accessId":"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC","securityToken":null,"endpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","accessKey":"***","name":"PRE_PROJECT_A_engine","project":"PRE_PROJECT_A","vpcEndpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","region":"cn-shanghai","authType":"2"}</Content>
        <DataSourceType>rds</DataSourceType>
        <Id>1</Id>
    </DataSources>
</Data>
<Success>true</Success>

Format JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "0bc14115159376359****",
  "HttpStatusCode" : 200,
  "Data" : {
    "TotalCount" : 233,
    "PageSize" : 20,
    "PageNumber" : 1,
    "DataSources" : {
      "Status" : 1,
      "Operator" : "193543050****",
      "ConnectStatus" : 1,
      "SubType" : "mysql",
      "Description" : "a connection",
      "BindingCalcEngineId" : 123,
      "ProjectId" : 123,
      "GmtModified" : "Mar 17, 2021 4:09:32 PM",
      "Sequence" : 300,
      "Shared" : false,
      "EnvType" : 1,
      "Name" : "abc",
      "DefaultEngine" : false,
      "TenantId" : 1234567,
      "GmtCreate" : "Mar 17, 2021 4:09:32 PM",
      "Content" : "{\"pubEndpoint\":\"http://service.cn.maxcompute.aliyun.com/api\",\"accessId\":\"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC\",\"securityToken\":null,\"endpoint\":\"http://service.cn.maxcompute.aliyun-inc.com/api\",\"accessKey\":\"***\",\"name\":\"PRE_PROJECT_A_engine\",\"project\":\"PRE_PROJECT_A\",\"vpcEndpoint\":\"http://service.cn.maxcompute.aliyun-inc.com/api\",\"region\":\"cn-shanghai\",\"authType\":\"2\"}",
      "DataSourceType" : "rds",
      "Id" : 1
    }
  },
  "Success" : true
}

Codes d’erreur

Code d'état HTTP	Code d'erreur	Message d'erreur	Description
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.	La source de données spécifiée n’existe pas.
400	Invalid.Tenant.ProjectNotExists	The project does not exist.	L’espace de travail spécifié n’existe pas.
400	Invalid.Tenant.UserNotInProject	The user is not in the project.	L’utilisateur n’a pas été ajouté à l’espace de travail.
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.	L’utilisateur n’est ni le propriétaire ni l’administrateur de l’espace de travail.
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.	L’utilisateur n’appartient pas au locataire.

Pour obtenir la liste des codes d’erreur, consultez les Codes d’erreur de service.