Skip to main content

ListPlanningProposal

Retrieves a list of planning proposals.

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:ListPlanningProposal

list

*All Resource

*

NoneNone

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

AgentKey

string

Yes

The unique identifier of the workspace: AgentKey

xxxxx_p_efm

ViewPointType

string

Yes

Planning proposal type

  • CustomViewPoints: Custom viewpoint

  • HotViewPoints: Hot viewpoint

  • TimedViewPoints: Time-sensitive viewpoint

  • WebReviewPoints: User viewpoint

  • FreshViewPoints: Fresh viewpoint

CustomViewPoints

Titles

array

No

Filter planning proposal titles, corresponding to the viewpoint names of each planning proposal type.

Title *

string

No

Viewpoint filter.

Title *

CustomViewPointId

string

No

Custom viewpoint ID (used for custom viewpoint planning proposal scenarios).

e7b26a9e1211444db8f0a984361a5e0f

CustomViewPointIds

array

No

List of custom viewpoint IDs (used for custom viewpoint planning proposal scenarios).

27971fc8f3ce4ed58c7e7fc4b503e432

string

No

Custom viewpoint ID (used for custom viewpoint planning proposal scenarios) *

3c67e87fc9044a8aae534f617195ab31

TopicSource

string

Yes

Hot topic source.

Hot topic source

Topic

string

Yes

Hot topic subject.

Hot topic subject

TopicVersion

string

No

Hot spot event data version.

2024-09-10_08

NextToken

string

No

Token for the next page.

Token for the next page

MaxResults

integer

No

Maximum number of returned results.

73

Response elements

Element

Type

Description

Example

object

PageResult2

Code

string

Status code.

NoData

Data

array<object>

Business data.

array<object>

Planning proposal object.

Outlines

array<object>

Outline list.

object

Outline object.

Outline

string

Outline.

Outline

Summary

string

Outline summary.

Outline summary

Summary

string

Summary.

Summary

Title

string

Title.

Title

HttpStatusCode

integer

HTTP status code.

200

MaxResults

integer

Maximum number of returned results.

77

Message

string

Fault description.

success

NextToken

string

Token for the next page.

Token for the next page

RequestId

string

Unique request identity.

1813ceee-7fe5-41b4-87e5-982a4d18cca5

Success

boolean

Is successful: true for success, false for failure.

true

TotalCount

integer

Total count.

80

Examples

Success response JSON format
{
  "Code": "NoData",
  "Data": [
    {
      "Outlines": [
        {
          "Outline": "Outline",
          "Summary": "Outline summary"
        }
      ],
      "Summary": "Summary",
      "Title": "Title"
    }
  ],
  "HttpStatusCode": 200,
  "MaxResults": 77,
  "Message": "success",
  "NextToken": "Token for the next page",
  "RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
  "Success": true,
  "TotalCount": 80
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.
Token Plan
Model Playground
  • 3D model generation
  • Audio generation
Fine-tuning
Model Compression
Statistics and Monitoring
Support