GetCustomText
Retrieve custom text.
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:GetCustomText | get | *All Resource
| None | None |
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| AgentKey | string | Yes | Workspace unique identifier: AgentKey | xxxxx_p_efm |
| Id | integer | Yes | Primary key ID | 63 |
| CommodityCode | string | No | Product code | 商品code |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | PlainResult | ||
| Code | string | Status code | NoData |
| Data | object | Business data | |
| Content | string | Content | 内容 |
| CreateTime | string | Creation time | 创建时间 |
| CreateUser | string | Created by | 创建用户 |
| Id | integer | Primary key ID | 34 |
| Title | string | Title | 标题 |
| UpdateTime | string | Update time | 修改时间 |
| UpdateUser | string | Update user | 修改用户 |
| HttpStatusCode | integer | HTTP status code | 200 |
| Message | string | Fault description | success |
| RequestId | string | Unique request identifier | 1813ceee-7fe5-41b4-87e5-982a4d18cca5 |
| Success | boolean | Is successful: true for success, false for failure | true |
Examples
Success response
JSON format
{
"Code": "NoData",
"Data": {
"Content": "内容",
"CreateTime": "创建时间",
"CreateUser": "创建用户",
"Id": 34,
"Title": "标题",
"UpdateTime": "修改时间",
"UpdateUser": "修改用户"
},
"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.