UpdateDataSource API によるデータソースの更新 - DataWorks

データソースを更新します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
Description	string	任意	データソースの説明。	xxx
EnvType	integer	任意	データソースが存在する環境。有効値： 0：開発環境 1：本番環境	1
Content	string	任意	データソースの詳細。データソースのタイプは変更できません。たとえば、データソースタイプを MaxCompute から MySQL に変更することはできません。一般的なデータソースの詳細の例は次のとおりです： odps `{ "accessId": "***", "accessKey": "*", "authType": 2, "endpoint": "http://service.odps.aliyun.com/api", "project": "xsaxsax", "tag": "public" }` mysql `{ "database": "xsaxsa", "instanceName": "rm-xsaxsa", "password": "xsaxsa", "rdsOwnerId": "xasxsa", "regionId": "cn-shanghai", "tag": "rds", "username": "xsaxsa" }` rds `{ "configType": 1, "tag": "rds", "database": "xsaxsa", "username": "xsaxsa", "password": "xssaxsa$32050", "instanceName": "rm-xsaxs", "rdsOwnerId": "11111111" }` oss `{ "accessId": "*", "accessKey": "*", "bucket": "xsa-xs-xs", "endpoint": "http://oss-cn-shanghai.aliyuncs.com", "tag": "public" }` sqlserver `{ "jdbcUrl": "jdbc:sqlserver://xsaxsa-xsaxsa.database.xxx.cn:123;DatabaseName=xsxs-xsxs", "password": "sdasda$fs", "tag": "public", "username": "sxaxacdacdd" }` polardb `{ "clusterId": "pc-sdadsadsa", "database": "dsadsadsa", "ownerId": "121212122", "password": "sdasdafssa", "region": "cn-shanghai", "tag": "polardb", "username": "asdadsads" }` oracle `{ "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD", "password": "sxasaxsa", "tag": "public", "username": "sasfadfa" }` mongodb `{ "address": "[\"xsaxxsa.mongodb.rds.aliyuncs.com:3717\"]", "database": "admin", "password": "sadsda@", "tag": "public", "username": "dsadsadas" }` emr `{ "accessId": "*", "emrClusterId": "C-dsads", "emrResourceQueueName": "default", "emrEndpoint": "emr.aliyuncs.com", "accessKey": "*", "emrUserId": "224833315798889783", "name": "sasdsadsa", "emrAccessMode": "simple", "region": "cn-shanghai", "authType": "2", "emrProjectId": "FP-sdadsad" }` postgresql `{ "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss", "password": "sdadsads", "tag": "public", "username": "sdsasda" }` analyticdb_for_mysql `{ "instanceId": "am-sadsada", "database": "xsxsx", "username": "xsxsa", "password": "asdadsa", "connectionString": "am-xssxsxs.ads.aliyuncs.com:3306" }` hybriddb_for_postgresql `{ "connectionString": "gp-xsaxsaxa-master.gpdbmaster.rds.aliyuncs.com", "database": "xsaxsaxas", "password": "xsaxsaxsa@11", "instanceId": "gp-xsaxsaxsa", "port": "541132", "ownerId": "xsaxsaxsas", "username": "sadsad" }` holo `{ "accessId": "*", "accessKey": "***", "database": "xsaxsaxsa", "instanceId": "xsaxa", "tag": "aliyun" }` kafka `{ "instanceId": "xsax-cn-xsaxsa", "regionId": "cn-shanghai", "tag": "aliyun", "ownerId": "1212121212112" }`	{"accessId":"***","accessKey":"***","authType":2,"endpoint":"http://service.odps.aliyun.com/api","project":"xsaxsax","tag":"public"}
Status	string	任意	データソースのステータス。このパラメーターは非推奨です。このパラメーターは使用しないでください。	ENABLED
DataSourceId	integer	必須	データソースの ID。「ListDataSources」操作を呼び出して ID を照会できます。	1

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
HttpStatusCode	string	HTTP ステータスコード。	200
Data	boolean	データソースが更新されたかどうかを示します。	true
RequestId	string	リクエスト ID。	0bc14115159376359****
Success	boolean	リクエストが成功したかどうかを示します。	true

例

成功レスポンス

JSONJSON

{
  "HttpStatusCode": "200",
  "Data": true,
  "RequestId": "0bc14115159376359****",
  "Success": true
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Invalid.Tenant.ConnectionNotExists	The connection does not exist.
400	Invalid.Tenant.ProjectNotExists	The project does not exist.
400	Invalid.Tenant.UserNotInProject	The user is not in the project.
400	MissingParam.ConnectionStr.Property	You must specify property %s required by the data source connection string.
400	DataSource.CheckRamRoleFailure	Failed to check the RAM role. AccountId %s. roleArn %s.
400	DataSource.ConnectionStrProperty.PatternNotMatch	The pattern value %s is invalid. The correct pattern is %s.
400	DataSource.NotFound	The specified data source ID %s does not exist.
400	Invalid.Connection.Empty	You must specify the connection parameter.
400	Invalid.DataSource.DataSourceTypeNotExist	The data source type %s does not exist.
400	Invalid.DataSource.DataSourceTypeNotSupport	The dataSourceType %s and subType %s are not supported.
400	Invalid.Operation	You cannot delete the bindingCalcEngine that is bound to the data source.
400	Invalid.Param.Odps.EngineIdOrConnectStrEmpty	Either the compute engine ID or the connection string must be specified when data source type is ODPS.
400	Required.Parameter.Empty	You must specify the parameter %s.
403	Invalid.Tenant.UserIsNotProjectOwnerOrAdmin	The user is not a project administrator or owner.
403	Invalid.Tenant.UserNotInTenant	The user is not in tenant.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。