DescribeAtiAgentRegisterInfo - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries the details of Agent registration information.

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. If you do not specify this parameter, the system automatically uses the value of RequestId as the value of ClientToken. The value of RequestId may be different for each request.	eyJhbGciOiJIUzI1NiIsInR5cC.....
AgentRegisterInfoId	string	Yes	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 the multi-step registration process through the API, this ID must be carried throughout all steps to ensure that each step is associated with the same Agent and the complete registration process is completed.	2074753647748672512

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	536E9CAD-DB30-4647-AC87-AA5CC38C5382
AgentRegisterInfoId	string	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 the multi-step registration process through the API, this ID must be carried throughout all steps to ensure that each step is associated with the same Agent and the complete registration process is completed.	2074753647748672512
AgentId	string	The Agent ID, which is uniformly assigned by CNNIC after real-name authentication. The Agent ID serves as the unique identifier that binds the Agent to the authenticated registrant.	019f3672-9705-7a7a-88fd-9a6a211aa5f2
AgentDisplayName	string	The display name of the Agent.	TestAgent
AgentHost	string	The endpoint domain name through which the Agent provides external services.	example.com
AgentVersion	string	The version of the Agent.	1.0.1
AgentDescription	string	The capability description of the Agent.	Payment service
Status	string	The Agent status. Valid values: Draft: The Agent registration form is being filled out and has not been formally submitted. In draft status, only modification and detail viewing operations are supported. Private CA Pending Issuance: The Agent registration has been formally submitted. Alibaba Cloud has completed the ACME DNS-01 pre-check and submitted the registration information and generated DNS records to CNNIC. Currently waiting for CNNIC to approve and issue the Private CA and complete TL sealing. DNS Pending Verification: CNNIC has approved and issued the Private CA certificate and completed TL sealing, but the DNS records of the user have not been verified. Waiting for the user to add the corresponding DNS records in domain name resolution and complete verification. Active: All processes are complete. The Private CA certificate has been issued, TL has been sealed, and DNS records have been verified. The Agent is activated and can be discovered and trust-verified across the network. Expired: The Agent identity certificate has expired, and the user did not complete certificate renewal within the validity period. Revoked: The Agent certificate has been revoked, DNS records have been cleaned up, and the Agent cannot be discovered or trust-verified. It cannot be restored to active status.	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:// — The protocol prefix that identifies this as a resource in the ATI system. v1.0.0 — The Agent version number. www.example.com — The domain name (FQDN) bound to the Agent.	ati://v1.0.0.www.example.com
RegistrantId	string	The ID of the authenticated registrant.	2072277378616354816
RegistrantName	string	The name of the registrant.	Zhang xx
CreateTimestamp	integer	The creation time (timestamp).	1527690629357
UpdateTimestamp	integer	The update time (timestamp).	1527690629357
TrustCardUrl	string	[Deprecated]	Deprecated
Endpoints	object
Endpoint	array<object>	The access points for each protocol.
	array<object>	The access points for each protocol.
Protocol	string	The communication protocol standard that the Agent endpoint follows, which determines how callers interact with the Agent. Valid values: MCP: Model Context Protocol, an Agent tool calling 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 the MCP SDK, A2A uses the A2A SDK, and OpenAPI uses standard HTTP requests.	MCP
AgentUrl	string	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, it can use this URL to directly initiate a connection. This is the address where the Agent is actually "online".	https://www.example.com/mcp
Transports	object
Transport	array	The transport methods.
	string	The communication transport mechanism supported by the Agent endpoint, which works in conjunction with the protocol. The following table describes the mapping between protocols and available transport methods: 1. Protocol: MCP. Available transport methods: STREAMABLE-HTTP, SSE. Description: MCP protocol supports streaming HTTP and Server-Sent Events. 2. Protocol: A2A. Available transport methods: STREAMABLE-HTTP, SSE. Description: A2A protocol also supports these two methods. 3. Protocol: OpenAPI. Available transport methods: REST, HTTP. Description: Traditional REST API communication methods.	STREAMABLE-HTTP
MetadataUrl	string	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 through this URL 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" } }
RejectReason	object	The reason for Agent registration review failure.
Type	string	The type of review failure. Valid values: ACME_VERIFY_FAILED: ACME verification failed. INFO_AUDIT_FAILED: Agent information review failed.	ACME_VERIFY_FAILED
Message	string	The detailed information about the Agent registration failure.	Invalid status
IdentityCertSerialNumber	string	Ignore.	Ignore
ServerCertSerialNumber	string	Ignore.	Ignore
TrustCard	string	Ignore.	Ignore
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.	RemoveRspDomainServerHoldStatusForGateway
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: ExplicitDeny: Explicit deny. ImplicitDeny: Implicit deny.	ImplicitDeny
PolicyType	string	The policy type.	DlpSend
TrustLevel	string
DomainMode	string
AgentSubHost	string

Examples

Success response

JSON format

{
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "AgentRegisterInfoId": "2074753647748672512",
  "AgentId": "019f3672-9705-7a7a-88fd-9a6a211aa5f2",
  "AgentDisplayName": "测试Agent",
  "AgentHost": "example.com\n",
  "AgentVersion": "1.0.1",
  "AgentDescription": "支付服务\n",
  "Status": "活跃",
  "AtiName": "ati://v1.0.0.www.example.com",
  "RegistrantId": "\t\n2072277378616354816",
  "RegistrantName": "张xx",
  "CreateTimestamp": 1527690629357,
  "UpdateTimestamp": 1527690629357,
  "TrustCardUrl": "已废弃",
  "Endpoints": {
    "Endpoint": [
      {
        "Protocol": "MCP",
        "AgentUrl": "https://www.example.com/mcp\n",
        "Transports": {
          "Transport": [
            "STREAMABLE-HTTP\n"
          ]
        },
        "MetadataUrl": "// https://my-agent.example.com/.well-known/agent.json\n{\n  \"name\": \"智能客服助手\",\n  \"version\": \"1.2.0\",\n  \"protocol\": \"MCP\",\n  \"description\": \"提供产品咨询、订单查询、售后服务的智能客服Agent\",\n  \"capabilities\": {\n    \"tools\": [\n      { \"name\": \"order_query\", \"description\": \"查询订单状态\" },\n      { \"name\": \"product_search\", \"description\": \"搜索产品信息\" },\n      { \"name\": \"refund_request\", \"description\": \"发起退款申请\" }\n    ],\n    \"resources\": [\n      { \"uri\": \"faq://knowledge-base\", \"description\": \"FAQ知识库\" }\n    ]\n  },\n  \"endpoint\": {\n    \"url\": \"https://my-agent.example.com/mcp\",\n    \"transport\": [\"STREAMABLE-HTTP\", \"SSE\"]\n  },\n  \"policy\": {\n    \"authentication\": \"mTLS\",\n    \"rateLimit\": \"100/min\"\n  }\n}"
      }
    ]
  },
  "RejectReason": {
    "Type": "ACME_VERIFY_FAILED",
    "Message": "非法状态"
  },
  "IdentityCertSerialNumber": "忽略",
  "ServerCertSerialNumber": "忽略",
  "TrustCard": "忽略",
  "AccessDeniedDetail": {
    "AuthAction": "RemoveRspDomainServerHoldStatusForGateway",
    "AuthPrincipalDisplayName": "2015555733387XXXX",
    "AuthPrincipalOwnerId": "1046973331XXXX",
    "AuthPrincipalType": "SubUser",
    "EncodedDiagnosticMessage": "AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ==",
    "NoPermissionType": "ImplicitDeny",
    "PolicyType": "DlpSend"
  },
  "TrustLevel": "",
  "DomainMode": "",
  "AgentSubHost": ""
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.