DocsICP FilingConsole
Documentation

ListCustomText

Updated at:
Copy as MD
Product
My Favorites

Retrieve a list of custom texts.

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

list

*All Resource

*

NoneNone

Request parameters

Parameter

Type

Required

Description

Example

AgentKey

string

Yes

Unique identifier of the workspace. For more information, see AgentKey.

xxxxx_p_efm

CommodityCode

string

No

Commodity code.

商品code

Response elements

Element

Type

Description

Example

object

PlainResult

Code

string

Status code.

successful

Data

array<object>

Business data.

object

Document object.

Content

string

Content.

内容

CreateTime

string

Creation time.

创建时间

CreateUser

string

The user who created the custom text.

创建用户

Id

integer

Primary key ID.

40

Title

string

Title.

标题

UpdateTime

string

Update time.

修改时间

UpdateUser

string

Modifier.

修改用户

HttpStatusCode

integer

HTTP status code.

200

Message

string

Error description.

successful

RequestId

string

Unique request ID.

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

Success

boolean

Indicates whether the request is successful. true: successful, false: failed.

true

Examples

Success response

JSON format

{
  "Code": "successful",
  "Data": [
    {
      "Content": "内容",
      "CreateTime": "创建时间",
      "CreateUser": "创建用户",
      "Id": 40,
      "Title": "标题",
      "UpdateTime": "修改时间",
      "UpdateUser": "修改用户"
    }
  ],
  "HttpStatusCode": 200,
  "Message": "successful",
  "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.