DescribeAtiAgentRegisterInfoMarket - Alibaba Cloud DNS - Alibaba Cloud Documentation Center

Queries agent information from the Agent marketplace for the SDK.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

alidns:DescribeAtiAgentRegisterInfoMarket

list

*All Resource

*

None

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.	eyJhbGciOiJIUzI1NiIsInR5cC.....
AgentHost	string	No	The endpoint domain name through which the agent provides services externally.	example.com
AgentVersion	string	No	The agent version.	5.0.1
MaxResults	integer	No	The maximum number of entries to return in this request.	100
NextToken	string	No	The pagination token for the next query.	4698691
		No

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The unique request ID.	0629502C-6224-5DC9-A8ED-2ED73A2E3931
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 verification. The AgentID serves as the unique identifier that binds the agent to the real-name authenticated registrant.	gsc01629925@5e0964fd-951c-4e45-b518-d09d4d2db8ca
AgentDisplayName	string	The display name of the agent.	TestAgent
AgentHost	string	The host address of the agent.	www.example.com
AgentVersion	string	The agent version.	3.9.3
AgentDescription	string	The capability description of the agent.	Payment service
Status	string	The status of the DNS record. Valid values: Enable: DNS resolution is enabled. Disable: DNS resolution is paused.	Disable
TrustLevel	string	The trust level. Valid values: Basic authentication Enhanced authentication Advanced authentication	基础认证
Categories	object
category	array	Ignore.
	string	Ignore.	忽略
TrustCardContent	string	Ignore.	忽略
Endpoints	object
Endpoint	array<object>	The endpoints for each protocol.
	array<object>	The endpoints for each protocol.
Protocol	string	The communication protocol standard that the agent endpoint follows, which determines how callers invoke 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). Other agents or clients use this protocol identity to determine how to communicate with the agent. For example, MCP protocol uses the MCP SDK, A2A uses the A2A SDK, and OpenAPI uses standard HTTP requests.	https
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 Callers can initiate a connection directly using this URL after discovering the agent through DNS. This is the address where the agent is actually online.	https://www.example.com/mcp
Transports	object
Transport	array	The transport method.
	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: Protocol: MCP. Available transport methods: STREAMABLE-HTTP, SSE. Description: MCP protocol supports streaming HTTP and Server-Sent Events. Protocol: A2A. Available transport methods: STREAMABLE-HTTP, SSE. Description: A2A protocol also supports these two methods. 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). This allows other agents or clients to automatically discover the agent's capability description 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" } }
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.	AddRspDomainServerHoldStatusForGatewayOte
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 denial. ImplicitDeny: Implicit denial.	ImplicitDeny
PolicyType	string	The policy type.	DlpSend
NextToken	string	The pagination token for the next query.	4698691
MaxResults	integer	The maximum number of entries to return in this request.	500

Examples

Success response

JSON format

{
  "RequestId": "0629502C-6224-5DC9-A8ED-2ED73A2E3931",
  "AgentRegisterInfoId": "2074753647748672512",
  "AgentId": "gsc01629925@5e0964fd-951c-4e45-b518-d09d4d2db8ca",
  "AgentDisplayName": "测试Agent",
  "AgentHost": "www.example.com",
  "AgentVersion": "3.9.3",
  "AgentDescription": "支付服务",
  "Status": "Disable",
  "TrustLevel": "基础认证",
  "Categories": {
    "category": [
      "忽略"
    ]
  },
  "TrustCardContent": "忽略",
  "Endpoints": {
    "Endpoint": [
      {
        "Protocol": "https",
        "AgentUrl": "https://www.example.com/mcp",
        "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}"
      }
    ]
  },
  "AccessDeniedDetail": {
    "AuthAction": "AddRspDomainServerHoldStatusForGatewayOte",
    "AuthPrincipalDisplayName": "2015555733387XXXX",
    "AuthPrincipalOwnerId": "1046973331XXXX",
    "AuthPrincipalType": "SubUser",
    "EncodedDiagnosticMessage": "AQFohtp4aIbaeEXXXXQxNjFDLUIzMzgtNTXXXX05NkFCLUI2RkY5XXXXzAzQQ==",
    "NoPermissionType": "ImplicitDeny",
    "PolicyType": "DlpSend"
  },
  "NextToken": "4698691",
  "MaxResults": 500
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.