GetTopicById

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.

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
aimiaobi:GetTopicById	get	All Resource ``	None	None

Action

Access level

Resource type

Condition key

Dependent action

aimiaobi:GetTopicById

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
AgentKey	string	Yes	Workspace unique identifier: AgentKey	xxxxx_p_efm
Id	string	Yes	Data ID	Data ID

Response elements

Element	Type	Description	Example
	object	PlainResult
Code	string	Status code	NoData
Data	object	Business data
AsyncTaskId	string	Asynchronous task ID (used in custom topic scenarios)	Asynchronous task ID (used in custom topic scenarios)
CreateUser	string	Creator user ID (used in custom topic scenarios)	Creator user ID (used in custom topic scenarios)
HotValue	integer	Hotness value	43
Id	string	Hot topic ID	Hot topic ID
Status	string	Asynchronous task status (used in custom event scenarios) (PENDING: pending, RUNNING: running, SUCCESSED: succeeded, SUSPENDED: suspended, FAILED: failed, CANCELED: canceled)	PENDING
StructureSummary	array<object>	List of structured topic summaries
	array<object>	Structured topic summary object
DocList	array<object>	Articles referenced to generate the title summary
	object	Article object
Source	string	Article source	Toutiao
Title	string	Article title	Article title
Url	string	Article URL	http://www.example.com
Summary	string	Summary	Summary
Title	string	Title	Title
Summary	string	Hot topic summary	Hot topic summary
TaskErrorMessage	string	Error message for asynchronous task failure	Error message for asynchronous task failure
TaskStatus	integer	Asynchronous task status. 0: pending, 1: running, 2: succeeded, 3: suspended (not used), 4: failed, 6: canceled (used in custom event scenarios).	14
Topic	string	Unique topic name	Unique topic name
TopicSource	string	Hot topic source. Supported sources: Toutiao: Toutiao Quark: Quark Baidu: Baidu Sina: Sina Custom: Custom Aggregation: Hot Topic List	Toutiao
Version	string	Data version	Data version
HttpStatusCode	integer	HTTP status code	200
Message	string	Error description	success
RequestId	string	Unique request identifier	1813ceee-7fe5-41b4-87e5-982a4d18cca5
Success	boolean	Indicates whether the operation succeeded: true for success, false for failure	true

Examples

Success response JSON format

{
  "Code": "NoData",
  "Data": {
    "AsyncTaskId": "异步任务ID（自定义主题场景下使用）",
    "CreateUser": "创建用户ID（自定义主题场景下使用）",
    "HotValue": 43,
    "Id": "热榜ID",
    "Status": "PENDING",
    "StructureSummary": [
      {
        "DocList": [
          {
            "Source": "头条",
            "Title": "文章标题",
            "Url": "http://www.example.com"
          }
        ],
        "Summary": "摘要",
        "Title": "标题"
      }
    ],
    "Summary": "热榜摘要",
    "TaskErrorMessage": "异步任务失败错误信息",
    "TaskStatus": 14,
    "Topic": "主题唯一名称",
    "TopicSource": "Toutiao",
    "Version": "数据版本"
  },
  "HttpStatusCode": 200,
  "Message": "success",
  "RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

​Try it now

​RAM authorization

​Request syntax

​Request parameters

​Response elements

​Examples

​Error codes

​Release notes