Creates a parser.

QPS limits

Each Alibaba Cloud account can run up to 10 queries per second (QPS).

Note The RAM users of an Alibaba Cloud account share the quota of the Alibaba Cloud account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateParser

The operation that you want to perform. Set the value to CreateParser.

Name String Yes DataParser

The name of the parser. The name must be 1 to 30 characters in length, and can contain letters, digits, underscores (_), and hyphens (-).

IotInstanceId String No iot-n8t***

The ID of the instance. You can view the ID of the instance on the Overview page in the IoT Platform console.

Notice
  • If your instance has an ID, you must specify the ID for this parameter. Otherwise, the call fails.
  • If no Overview page or ID is generated for your instance, you do not need to configure this parameter.

For more information, see Overview.

Description String No Forward data.

The description of the parser.

In addition to the preceding operation-specific request parameters, you must configure common request parameters when you call this operation. For more information, see Common request parameters.

Response parameters

Parameter Type Example Description
Code String iot.system.SystemException

The error code returned if the call fails. For more information, see Error codes.

ErrorMessage String A system exception occurred.

The error message returned if the request fails.

ParserId String 100*

The parser ID returned if the parser is created.

RequestId String 291438BA-6E10-4C4C-B761-243B9A0D324F

The ID of the request.

Success Boolean true

Indicates whether the call was successful.

  • true: The call was successful.
  • false: The request failed.

Examples

Sample requests

http(s)://iot.cn-shanghai.aliyuncs.com/?Action=CreateParser
&Name=DataParser
&<Common request parameters>

Sample success responses

XML format 

<CreateParserResponse>
  <RequestId>291438BA-6E10-4C4C-B761-243B9A0D324F</RequestId>
  <ParserId>100*</ParserId>
  <Success>true</Success>
</CreateParserResponse>

JSON format 

{
    "RequestId": "291438BA-6E10-4C4C-B761-243B9A0D324F",
    "ParserId": "100*",
    "Success": true
}