UpdateAtiAgentRegisterInfo - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Updates the registration information of an Agent.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters and cannot exceed 64 characters in length. If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	eyJhbGciOiJIUzI1NiIsInR5cC.....
AgentRegisterInfoId	string	No	The Agent registration ID. This ID is automatically generated by the Alibaba Cloud ATS platform and is globally unique within the platform. It is automatically generated during the Agent registration process. In API registration and query workflows, this ID must be carried throughout the entire process. Call the ListAtiAgentRegisterInfos operation to query the target Agent and obtain the AgentRegisterInfoId from the response.	2074753647748672512
AgentDisplayName	string	No	The display name of the Agent.	TestAgent
AgentHost	string	No	The host address of the Agent.	example.com
AgentVersion	string	No	The version of the Agent.	1.0.0
AgentDescription	string	No	The capability description of the Agent.	Payment service
RegistrantId	string	No	The ID of the real-name authenticated registrant.	2072277378616354816
Endpoints	array<object>	No	The endpoints for each protocol.	https://example.com/mcp
	object	No	The endpoints for each protocol.
AgentUrl	string	No	The actual service address of the Agent endpoint, which is the HTTPS entry point where the Agent runs online. This is a required field with a maximum of 500 characters. Example: https://my-agent.example.com/mcp Purpose: After a caller discovers this Agent through DNS, the caller can use this URL to directly initiate a connection. This is the address where the Agent is actually "online".	https://my-agent.example.com/mcp
Protocol	string	No	The communication protocol standard that the Agent endpoint follows, which determines how callers interact with the Agent: 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 communicate with the Agent. For example, MCP protocol uses MCP SDK, A2A uses A2A SDK, and OpenAPI uses standard HTTP requests.	mcp
Transports	array	No	The transport methods.
	string	No	The communication transport mechanisms supported by the Agent endpoint, which are associated with the protocol: Protocol: MCP. Available transports: STREAMABLE-HTTP, SSE. Description: MCP protocol supports streaming HTTP and Server-Sent Events. Protocol: A2A. Available transports: STREAMABLE-HTTP, SSE. Description: A2A protocol also supports these two transports. Protocol: OpenAPI. Available transports: REST, HTTP. Description: Traditional REST API communication methods.	[\"STREAMABLE-HTTP\",\"SSE\"]
MetadataUrl	string	No	An optional URL that points to the metadata description file of the Agent (typically in JSON format). Purpose: Allows other Agents or clients to automatically discover the capability description of the Agent before connecting, including: functions supported by the Agent, input/output formats, version information, and other capability declarations.	// https://my-agent.example.com/.well-known/agent.json { "name": "Intelligent Customer Service Assistant", "version": "1.2.0", "protocol": "MCP", "description": "An intelligent customer service Agent that provides product consultation, order queries, and after-sales services", "capabilities": { "tools": [ { "name": "order_query", "description": "Query order status" }, { "name": "product_search", "description": "Search product information" }, { "name": "refund_request", "description": "Initiate a refund request" } ], "resources": [ { "uri": "faq://knowledge-base", "description": "FAQ knowledge base" } ] }, "endpoint": { "url": "https://my-agent.example.com/mcp", "transport": ["STREAMABLE-HTTP", "SSE"] }, "policy": { "authentication": "mTLS", "rateLimit": "100/min" } }
		No
		No

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The unique request ID.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
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.	10469733312XXX
AuthPrincipalType	string	The identity type.	SubUser
EncodedDiagnosticMessage	string	The encoded diagnostic message.	AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng==
NoPermissionType	string	The reason for the authentication failure. Valid values: ExplicitDeny: Explicit deny. ImplicitDeny: Implicit deny.	ImplicitDeny
PolicyType	string	The policy type.	DlpSend

Examples

Success response

JSON format

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "Success": true,
  "AccessDeniedDetail": {
    "AuthAction": "CreateUser",
    "AuthPrincipalDisplayName": "2015555733387XXXX",
    "AuthPrincipalOwnerId": "10469733312XXX",
    "AuthPrincipalType": "SubUser",
    "EncodedDiagnosticMessage": "AQEAAAAAaNIARXXXXUQwNjE0LUQzN0XXXXVEQy1BQzExLTMzXXXXNTkxRjk1Ng==",
    "NoPermissionType": "ImplicitDeny",
    "PolicyType": "DlpSend"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.