Lists the AI tools provided by the observability service, including Copilot capabilities for various services.
Operation description
The endpoint for this API is available only in the China (Shanghai) and Singapore regions.
Try it now
Test
RAM authorization
Request syntax
GET /ml/tool/list HTTP/1.1
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
No parameters required.
Response elements
|
Element |
Type |
Description |
Example |
|
array |
|||
|
object |
|||
| fields |
array<object> |
The fields of the tool. |
|
|
object |
|||
| name |
string |
The name of the field. |
|
| option |
array |
The valid values for the field. |
|
|
string |
|||
| required |
boolean |
Indicates whether the field is required. |
|
| type |
string |
The type of the field. |
|
| example |
string |
An example of the field. |
|
| description |
string |
The description of the field. |
|
| name |
string |
The name of the tool. |
|
| description |
string |
The description of the tool. |
Examples
Success response
JSON format
[
{
"fields": [
{
"name": "",
"option": [
""
],
"required": false,
"type": "",
"example": "",
"description": ""
}
],
"name": "",
"description": ""
}
]
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.