Gunakan CreateDataServiceApi untuk membuat API-DataWorks-Alibaba Cloud -

Membuat API.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
TenantId	integer	No	ID penyewa.	10001
ProjectId	integer	Yes	ID ruang kerja.	10000
ApiName	string	Yes	Nama API. Nama harus terdiri dari 4 hingga 50 karakter. Nama dapat mengandung huruf, digit, dan garis bawah (_) serta harus diawali dengan huruf.	Test API name
GroupId	string	Yes	ID proses bisnis.	Business process ID
ApiMode	integer	Yes	Tipe API. Nilai valid: 0, 1, dan 2. Nilai 0 menunjukkan API dibuat dalam mode wizard. Nilai 1 menunjukkan API dibuat dalam mode skrip. Nilai 2 menunjukkan API dibuat melalui registrasi.	0
RequestMethod	integer	Yes	Metode permintaan API. Nilai valid: 0, 1, 2, dan 3. Nilai 0 menunjukkan metode GET. Nilai 1 menunjukkan metode POST. Nilai 2 menunjukkan metode PUT. Nilai 3 menunjukkan metode DELETE. API yang dibuat dalam mode wizard atau skrip mendukung metode GET dan POST. API yang dibuat melalui registrasi mendukung metode GET, POST, PUT, dan DELETE.	0
ResponseContentType	integer	Yes	Format pengembalian tanggapan permintaan API. Nilai valid: 0 dan 1. Nilai 0 menunjukkan format JSON. Nilai 1 menunjukkan format XML. API yang dibuat dalam mode wizard atau skrip mendukung format JSON. API yang dibuat melalui registrasi mendukung format JSON dan XML.	0
Timeout	integer	Yes	Periode waktu tunggu permintaan API. Unit: milliseconds. Nilai valid: (0,30000].	10000
VisibleRange	integer	Yes	Cakupan tempat API terlihat. Nilai valid: 0 dan 1. Nilai 0 menunjukkan API dapat dilihat oleh semua anggota di ruang kerja. Nilai 1 menunjukkan API hanya dapat dilihat oleh Pemilik.	0
Protocols	string	Yes	Protokol yang digunakan oleh API. Nilai valid: 0 dan 1. Nilai 0 menunjukkan HTTP. Nilai 1 menunjukkan HTTPS. Anda dapat menentukan beberapa protokol. Pisahkan dengan koma (,).	0,1
WizardDetails	string	No	Detail API yang dibuat dalam mode wizard. Untuk informasi lebih lanjut, lihat parameter WizardDetails yang dikembalikan oleh operasi GetDataServiceApi.	{"isPagedResponse":true,"wizardConnection":{"connectionId":122786,"tableName":"person"},"wizardRequestParameters":[{"columnName":"id","defaultValue":"","exampleValue":"1","isRequiredParameter":true,"parameterDataType":2,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":0}],"wizardResponseParameters":[{"columnName":"id","exampleValue":"11","parameterDataType":2,"parameterDescription":"","parameterName":"id"}]}
ScriptDetails	string	No	Detail API yang dibuat dalam mode skrip. Untuk informasi lebih lanjut, lihat parameter scriptDetails yang dikembalikan oleh operasi GetDataServiceApi.	{"isPagedResponse":false,"script":"select id as id1, name as name1 from person where id=${inputid}","scriptConnection":{"connectionId":122786,"tableName":"person"},"scriptRequestParameters":[{"defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"inputid","parameterOperator":0,"parameterPosition":1}],"scriptResponseParameters":[{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"id1"},{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"name1"}]}
RegistrationDetails	string	No	Detail API yang dibuat melalui registrasi. Untuk informasi lebih lanjut, lihat parameter registrationDetails yang dikembalikan oleh operasi GetDataServiceApi.	{"failedResultSample":"fail","registrationErrorCodes":[{"errorCode":"e1","errorMessage":"msg1","errorSolution":"sol1"},{"errorCode":"e2","errorMessage":"msg2","errorSolution":"sol2"}],"registrationRequestParameters":[{"columnName":"","defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":1},{"columnName":"","defaultValue":"xx","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"cc","parameterOperator":2,"parameterPosition":2}],"serviceContentType":1,"serviceHost":"http://www.baidu.com","servicePath":"/[uid]","serviceRequestBodyDescription":"body","successfulResultSample":"success"}
ApiPath	string	Yes	Path API. Path tidak boleh melebihi 200 karakter. Path dapat mengandung huruf, digit, garis bawah (_), dan tanda hubung (-) serta harus diawali dengan garis miring (/).	/test/1
ApiDescription	string	Yes	Deskripsi API.	Test API description
FolderId	integer	No	ID folder yang digunakan untuk menyimpan API. ID folder root dalam proses bisnis adalah 0. ID folder yang dibuat oleh pengguna harus lebih besar dari 0.	0
SqlMode	integer	No	Mode SQL. Nilai valid: 0: mode dasar. 1: mode MyBatis.	0
ResourceGroupId	integer	No	ID kelompok sumber daya eksklusif.	3242432423
RequestContentType	integer	No	Format data permintaan. Nilai valid: 0: format XML. 1: format JSON. 2: format formulir.	0

Elemen respons

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
Data	integer	The ID of the API.	100003
ErrorMessage	string	The error message.	The connection does not exist.
RequestId	string	The request ID.	0000-ABCD-EFG****
ErrorCode	string	The error code.	Invalid.Tenant.ConnectionNotExists
Success	boolean	Indicates whether the request was successful.	true

Contoh

Respons sukses

JSONformat

{
  "HttpStatusCode": 200,
  "Data": 100003,
  "ErrorMessage": "The connection does not exist.",
  "RequestId": "0000-ABCD-EFG****",
  "ErrorCode": "Invalid.Tenant.ConnectionNotExists",
  "Success": true
}

Kode kesalahan

HTTP status code	Error code	Error message
500	InternalError.System	An internal system error occurred. Try again later.
500	InternalError.UserId.Missing	An internal system error occurred. Try again later.
403	Forbidden.Access	Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.
429	Throttling.Api	The request for this resource has exceeded your available limit.
429	Throttling.System	The DataWorks system is busy. Try again later.
429	Throttling.User	Your request is too frequent. Try again later.

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.