ListCustomViewPoints
Lists custom viewpoints.
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
Actionelement 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
Resourceelement of the policy. - For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the
Resourceelement of the policy.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the
-
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:ListCustomViewPoints | list | *All Resource
| None | None |
Request syntax
POST HTTP/1.1
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| AgentKey | string | Yes | The unique identifier of the workspace. For more information, see AgentKey. | xxxxx_p_efm |
| Topic | string | No | The topic of the hot list. | 热榜主题 |
| Attitude | string | No | The viewpoint to filter by. | 观点 |
| Attitudes | array | No | A list of viewpoints to filter by. | 观点 * |
string | No | A viewpoint. | 观点 * | |
| CustomViewPointId | string | No | The ID of the custom viewpoint. | 461591f4880747f890702c1b90494d1a |
| CustomViewPointIds | array | No | A list of custom viewpoint IDs. | 7ece3d1212e04c9ca716ae2486228f3f |
string | No | A custom viewpoint ID. | bb1a5426a9c34e3e8165e7939032bddd | |
| TopicId | string | No | The topic ID. | 1d20ed14db0840efb1c7eaaf4d46352b |
| NextToken | string | No | The token for the next page of results. | 下一页的token |
| MaxResults | integer | No | The maximum number of results to return. | 52 |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | PageResult2 | ||
| Code | string | The status code. | NoData |
| Data | array<object> | The business data. | |
array<object> | |||
| AsyncTaskId | string | The ID of the asynchronous task that analyzes the custom viewpoint. | 2323ac73e174428a98c91097a59c67e0 |
| Attitude | string | The viewpoint. | 观点 |
| CreateTime | string | The time when the viewpoint was created. | 2024-08-15 16:18:59 |
| CreateUser | string | The ID of the user who created the viewpoint. | 1 |
| Id | string | The ID of the custom viewpoint. | 709806dd051042d5ab9de8bdbb3a64ca |
| Status | string | The task execution status. Valid values: PENDING, RUNNING, SUCCEEDED, SUSPENDED, FAILED, and CANCELED. | RUNNING |
| TaskErrorMessage | string | The error message for the task execution. | 参数校验失败 |
| TaskStatus | integer | The task execution status. 0: PENDING, 1: RUNNING, 2: SUCCEEDED, 3: PAUSED, 4: FAILED (retriable), 5: FAILED (non-retriable), 6: CANCELED. | 1 |
| ViewPoints | array<object> | A list of topic selection viewpoints. | |
array<object> | |||
| Outlines | array<object> | The outline. | |
object | |||
| Outline | string | The outline. | 大纲 |
| Summary | string | The summary of the outline. | 大纲摘要 |
| Point | string | The generated viewpoint. | 视角 |
| Summary | string | The summary. | 摘要 |
| HttpStatusCode | integer | The HTTP status code. | 200 |
| MaxResults | integer | The maximum number of results returned. | 60 |
| Message | string | The error description. | success |
| NextToken | string | The token for the next page of results. | 下一页的token |
| RequestId | string | The unique identifier of the request. | 1813ceee-7fe5-41b4-87e5-982a4d18cca5 |
| Success | boolean | Indicates whether the request was successful. `true`: The request was successful. `false`: The request failed. | true |
| TotalCount | integer | The total number of entries. | 73 |
Examples
Success response
JSON format
{
"Code": "NoData",
"Data": [
{
"AsyncTaskId": "2323ac73e174428a98c91097a59c67e0",
"Attitude": "观点",
"CreateTime": "2024-08-15 16:18:59",
"CreateUser": "1",
"Id": "709806dd051042d5ab9de8bdbb3a64ca",
"Status": "RUNNING",
"TaskErrorMessage": "参数校验失败",
"TaskStatus": 1,
"ViewPoints": [
{
"Outlines": [
{
"Outline": "大纲",
"Summary": "大纲摘要"
}
],
"Point": "视角",
"Summary": "摘要"
}
]
}
],
"HttpStatusCode": 200,
"MaxResults": 60,
"Message": "success",
"NextToken": "下一页的token",
"RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
"Success": true,
"TotalCount": 73
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.