Creating an FAQ

project_id

Yes

String

Definition:

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Constraints:

N/A

Value range:

The value can contain 1 to 64 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter.

Default value:

N/A

application_id

Yes

String

Definition:

Application ID. For details about how to obtain the application ID, see Obtaining an Application ID.

Constraints:

Character string

Value range:

The value can contain 1 to 64 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter.

Default value:

N/A

X-Auth-Token

Yes

String

Definition:

Token used for API authentication. For details about how to obtain the token, see Obtaining an IAM User Token.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

question

Yes

String

Definition:

Question.

Constraints:

N/A

Value range:

A maximum of 1,000 characters are allowed.

Default value:

N/A

answer

Yes

String

Definition:

Answer.

Constraints:

N/A

Value range:

The value cannot exceed 10,000 characters.

Default value:

N/A

repo_id

Yes

String

Definition:

Knowledge base ID.

Constraints:

N/A

Value range:

The value can contain a maximum of 64 characters.

Default value:

N/A

question1

No

String

Definition:

Similar questions.

Constraints:

N/A

Value range:

A maximum of 1,000 characters are allowed.

Default value:

N/A

question2

No

String

Definition:

Similar questions.

Constraints:

N/A

Value range:

A maximum of 1,000 characters are allowed.

Default value:

N/A

question3

No

String

Definition:

Similar questions.

Constraints:

N/A

Value range:

A maximum of 1,000 characters are allowed.

Default value:

N/A

question4

No

String

Definition:

Similar questions.

Constraints:

N/A

Value range:

A maximum of 1,000 characters are allowed.

Default value:

N/A

category

No

String

Definition:

Directory, which is a single value and corresponds to a leaf node in the directory tree.

Constraints:

N/A

Value range:

A maximum of 255 characters are allowed. Only non-control characters, non-private characters, and non-proxy characters are allowed.

Default value:

N/A

tags

No

String

Definition:

Tag list. Separate multiple tags by commas (,).

Constraints:

1. A document can have more than one tag.

2. It is recommended that the tag value be case insensitive.

3. Do not use reserved characters (+ - = && || > <!). Otherwise, you will need to escape them in queries. ( ) { } [ ] ^ " ~ * ? : \ /

4. The tag list must be replaced as a whole. Partial update is not supported.

Value range:

N/A

Default value:

N/A

faq_id

String

Definition:

ID of the created FAQ.

Value range:

N/A

200

Succeeded.