API ini menggunakan Server-Sent Events (SSE) untuk berinteraksi dengan Agen DAS. Anda dapat menggunakan API ini untuk fitur seperti tanya jawab dan diagnostik kinerja.
Deskripsi operasi
This is a paid API. You are charged based on the number of output characters. Before you use this API, ensure that you understand the billing methods and pricing of the DAS Agent product.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
hdm:GetDasAgentSSE |
get |
*全部资源
|
None | None |
Sintaks permintaan
POST /getDasAgentSSE HTTP/1.1
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| Query |
string |
Yes |
Kueri bahasa alami untuk agen. |
Are there any issues or abnormalities with my instance rm-xxx? |
| InstanceId |
string |
No |
Parameter ini sudah tidak digunakan lagi. Tentukan ID instans di parameter Query. |
rm-xxxx |
| SessionId |
string |
No |
ID Sesi, yang harus dalam format UUID. Parameter ini opsional. Jika Anda tidak menyediakan ID Sesi, layanan akan membuat Sesi baru. Untuk melanjutkan percakapan yang sudah ada, gunakan ID Sesi yang sama di permintaan berikutnya. |
123e4567-e89b-12d3-a456-xxxxxxxxxxxx |
| AgentId |
string |
No |
ID Agen yang akan digunakan. Parameter ini opsional. Jika Anda tidak menentukan parameter ini, layanan akan menggunakan Agen default. Anda dapat menyediakan ID Agen yang dihasilkan saat Anda mengaktifkan layanan DAS Agent atau yang Anda buat secara manual. |
ag-472T0DxtmjIxxxxx |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| Id |
string |
The session ID. This is the same as the SessionId in the request. |
123e4567-e89b-12d3-a456-xxxxxxxxxxxx |
| Answer |
string |
The content of the response. |
rm-xxxx |
| Metadata |
object |
The metadata. |
|
| Code |
integer |
The error code. This parameter is empty if no exception occurs. |
-1810001 |
| CharCount |
integer |
The number of characters in the response. |
1403 |
| ToolName |
string |
The name of the tool used. |
SqlFilter |
| ToolParams |
array |
The tool parameters. |
|
|
string |
A list of strings. |
["--instanceId", "rm-*****", "--sqlText", "select~from~das~where~name~das1"] |
|
| RequestId |
string |
The request ID. |
04930480-9404-50CB-8252-Axxxxxxxx |
| Event |
string |
The type of the response message. Valid values:
|
summary |
Contoh
Respons sukses
JSONformat
{
"Id": "123e4567-e89b-12d3-a456-xxxxxxxxxxxx",
"Answer": "rm-xxxx",
"Metadata": {
"Code": -1810001,
"CharCount": 1403,
"ToolName": "SqlFilter",
"ToolParams": [
"[\"--instanceId\", \"rm-*****\", \"--sqlText\", \"select~from~das~where~name~das1\"]"
],
"RequestId": "04930480-9404-50CB-8252-Axxxxxxxx"
},
"Event": "summary"
}
Kode kesalahan
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParams | The request parameters are invalid. | |
| 500 | Timeout | The request processing has failed due to timeout. | |
| 403 | NoPermission | You are not authorized to do this action. | |
| 404 | InstanceNotFound | Requested instance not found. |
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.