All Products
Search

This Product

    Alibaba Cloud DNS:CreateAtiAgentRegisterInfo

    Document Center

    Alibaba Cloud DNS:CreateAtiAgentRegisterInfo

    Last Updated:Aug 29, 2026

    Registers 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

    Provides idempotency. Within 3 minutes, the same value takes effect only once.

    eyJhbGciOiJIUzI1NiIsInR5cC.....
    AgentDisplayName

    string

    Yes

    The display name of the agent.

    TestAgent
    AgentHost

    string

    Yes

    The endpoint domain name through which the agent provides external services.

    example.com
    AgentVersion

    string

    Yes

    The version of the agent.

    1.0.1
    AgentDescription

    string

    No

    The description of the agent capabilities.

    PaymentService
    RegistrantId

    string

    Yes

    The ID of the registrant who has completed real-name verification. Obtain this ID by invoking the real-name verification API operation or from the ATS console.

    2072277378616354816
    Endpoints

    array<object>

    Yes

    The endpoint configuration of the agent.

    [{\"EndpointValue\":\"http://www.baidu.com\",\"EndpointType\":\"http\"}]

    object

    No

    [Deprecated] Use Endpoint instead.

    Protocol

    string

    No

    The communication protocol standard that the agent endpoint follows. This determines how callers interact with the agent.

    Valid values:

    • MCP: Model Context Protocol, an agent tool calling protocol developed by Anthropic.

    • A2A: Agent-to-Agent Protocol, a cross-agent communication protocol developed by Google.

    • OpenAPI: Standard RESTful API specification (Swagger/OpenAPI).

    Other agents or clients use this protocol identity to determine how to invoke the agent. For example, MCP uses the MCP SDK, A2A uses the A2A SDK, and OpenAPI uses standard HTTP requests.

    A2A
    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

    After a caller discovers this agent through DNS, the caller uses this URL to initiate a connection. This is the address where the agent is actually online.

    https://www.example.com/mcp
    Transports

    array

    No

    The transport methods.

    STREAMABLE-HTTP

    string

    No

    The communication transport mechanisms supported by the agent endpoint, which work in conjunction with the protocol:

    1. Protocol: MCP. Available transport methods: STREAMABLE-HTTP, SSE. Description: MCP supports streaming HTTP and Server-Sent Events.

    2. Protocol: A2A. Available transport methods: STREAMABLE-HTTP, SSE. Description: A2A also supports these two methods.

    3. Protocol: OpenAPI. Available transport methods: REST, HTTP. Description: Traditional REST API communication.

    STREAMABLE-HTTP
    MetadataUrl

    string

    No

    An optional URL that points to the metadata description file of the agent (typically in JSON format). This allows other agents or clients to automatically discover the agent capabilities before connecting, including:

    • Functions supported by the agent

    • Input/output formats

    • Version information

    • 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 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. During the multi-step registration process through the API, this ID must be carried throughout all steps to associate them with the same agent and complete the full registration workflow.

    2074031103110331392
    AtiName

    string

    The ATI name, which is a globally unique identifier within 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
    Status

    string

    The status of the resolution record. Valid values:

    • Enable: Resolution is enabled.

    • Disable: Resolution is paused.

    enable disable
    CreateTimestamp

    integer

    The creation time (timestamp).

    1527690629357
    AccessDeniedDetail

    object

    The details of the access denial. This field is returned only when RAM authentication fails.

    AuthAction

    string

    The unauthorized operation that was attempted.

    AddRspDomainServerHoldStatusForGateway
    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 complete diagnostic message.

    AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ==
    NoPermissionType

    string

    The reason for the authentication failure. Valid values:

    • ExplicitDeny: Explicit denial.

    • ImplicitDeny: Implicit denial.

    ImplicitDeny
    PolicyType

    string

    The policy type.

    DlpSend

    Examples

    Success response

    JSON format

    {
  "RequestId": "536E9CAD-DB30-4647-AC87-AA5CC38C5382",
  "AgentRegisterInfoId": "2074031103110331392",
  "AtiName": "ati://v1.0.0.www.example.com",
  "Status": "enable\ndisable",
  "CreateTimestamp": 1527690629357,
  "AccessDeniedDetail": {
    "AuthAction": "AddRspDomainServerHoldStatusForGateway",
    "AuthPrincipalDisplayName": "2015555733387XXXX",
    "AuthPrincipalOwnerId": "10469733312XXX",
    "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.