Queries the list of Agent registration information.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ClientToken |
string |
No |
Ensures the idempotency of the request. Generate a parameter value from your client to ensure uniqueness across different requests. ClientToken supports only ASCII characters and cannot exceed 64 characters in length. |
eyJhbGciOiJIUzI1NiIsInR5cC..... |
| PageSize |
integer |
Yes |
The page size for the paging query. |
2 |
| PageNumber |
integer |
Yes |
The current page number. The start value is 1. Default value: 1. |
1 |
| AgentId |
string |
No |
The Agent ID, which is uniformly assigned by CNNIC after real-name verification. The AgentID serves as the unique identifier that binds the Agent to the verified registrant. |
liuq@azt400 |
| AgentDisplayName |
string |
No |
The display name of the Agent. |
TestAgent |
| AgentHost |
string |
No |
The host address of the Agent. |
www.example.com |
| AgentVersion |
string |
No |
The version of the Agent. |
1.0.0 |
| Status |
string |
No |
The status of the Agent. |
Active |
| MaxResults |
integer |
No |
The maximum number of records to return in this request. |
100 |
| NextToken |
string |
No |
The token for the next query. |
4698691 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The unique request ID. |
536E9CAD-DB30-4647-AC87-AA5CC38C5382 |
| PageNumber |
integer |
The current page number. The start value is 1. Default value: 1. |
1 |
| PageSize |
integer |
The number of entries per page in the Settings for the paging query. Maximum value: 100. Default value: 20. |
20 |
| TotalPages |
integer |
The total number of pages. |
2 |
| TotalItems |
integer |
The total number of records. |
11 |
| AgentRegisterInfos |
object |
||
| AgentRegisterInfo |
array<object> |
The Agent information. |
|
|
array<object> |
|||
| AgentRegisterInfoId |
string |
The Agent registration ID. This ID is automatically generated by the Alibaba Cloud ATS platform and is globally unique within the platform. |
2074753647748672512 |
| AgentId |
string |
The Agent ID, which is uniformly assigned by CNNIC after real-name verification. The AgentID serves as the unique identifier that binds the Agent to the verified registrant. |
ag-6c6392b1d226d6e60f7020ce |
| AgentDisplayName |
string |
The display name of the Agent. |
TestAgent |
| AgentHost |
string |
The endpoint domain name through which the Agent provides services. |
example.com |
| AgentVersion |
string |
The version of the Agent. |
1.0.0 |
| Status |
string |
The status of the Agent. |
Active |
| AtiName |
string |
The ATI name, which is a globally unique identifier in the ATI trust system. Example: ati://v1.0.0.www.example.com
|
ati://v1.0.0.www.example.com |
| CreateTimestamp |
string |
The creation time (timestamp). |
1585808273000 |
| UpdateTimestamp |
string |
The time when the instance configuration was last modified (timestamp). |
1729590859000 |
| Endpoints |
object |
||
| Endpoint |
array<object> |
The access port. Valid values:
|
|
|
object |
The access port. Valid values:
|
||
| Protocol |
string |
Specifies the communication protocol standard that the Agent endpoint follows, which determines how the invoking party interacts with the Agent. Protocol descriptions: MCP: Model Context Protocol, an Agent tool invocation protocol introduced by Anthropic. A2A: Agent-to-Agent Protocol, a cross-Agent communication protocol introduced by Google. OpenAPI: Standard RESTful API specification (Swagger/OpenAPI). Purpose: When other Agents or clients see this protocol identity, they know which method to use to invoke the Agent. For example, MCP protocol uses MCP SDK, A2A uses A2A SDK, and OpenAPI uses standard HTTP requests. |
mcp |
| TrustLevel |
string |
||
| NextToken |
string |
The token for the next query. |
4698691 |
| MaxResults |
integer |
The maximum number of records to return in this request. |
500 |
| AccessDeniedDetail |
object |
The details about the access denial. This field is returned only when RAM authentication fails. |
|
| AuthAction |
string |
The unauthorized operation that was attempted. |
CreateUser |
| AuthPrincipalDisplayName |
string |
The display name of the authorization principal. |
2015555733387XXXX |
| AuthPrincipalOwnerId |
string |
The owner ID of the authorization principal. |
1046973331XXXX |
| AuthPrincipalType |
string |
The identity type. |
SubUser |
| EncodedDiagnosticMessage |
string |
The encrypted complete diagnostic message. |
AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ== |
| NoPermissionType |
string |
The reason for the authentication failure. Valid values:
|
ImplicitDeny |
| PolicyType |
string |
The policy type. |
DlpSend |
Examples
Success response
JSON format
{
"RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
"PageNumber": 1,
"PageSize": 20,
"TotalPages": 2,
"TotalItems": 11,
"AgentRegisterInfos": {
"AgentRegisterInfo": [
{
"AgentRegisterInfoId": "2074753647748672512",
"AgentId": "ag-6c6392b1d226d6e60f7020ce",
"AgentDisplayName": "测试Agent",
"AgentHost": "example.com",
"AgentVersion": "1.0.0",
"Status": "活跃",
"AtiName": "ati://v1.0.0.www.example.com",
"CreateTimestamp": "1585808273000",
"UpdateTimestamp": "1729590859000",
"Endpoints": {
"Endpoint": [
{
"Protocol": "mcp"
}
]
},
"TrustLevel": ""
}
]
},
"NextToken": "4698691",
"MaxResults": 500,
"AccessDeniedDetail": {
"AuthAction": "CreateUser",
"AuthPrincipalDisplayName": "2015555733387XXXX",
"AuthPrincipalOwnerId": "1046973331XXXX",
"AuthPrincipalType": "SubUser",
"EncodedDiagnosticMessage": "AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ==",
"NoPermissionType": "ImplicitDeny",
"PolicyType": "DlpSend"
}
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.