Creating an Application Rule

Function

Creates an application rule.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

POST /v1/{project_id}/app-center/app-rules

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Rule name: Contains visible characters or spaces but cannot contain only spaces. Contains 1 to 64 characters.
description	No	String	Rule description: Contains visible characters or spaces but cannot contain only spaces. Contains 0 to 128 characters.
rule	Yes	Rule object	Rule information.

**Table 4** Rule
Parameter	Mandatory	Type	Description
scope	Yes	String	Application scope of a rule: PRODUCT: product PATH: path
product_rule	No	ProductRule object	Product rule information. The process name, product name, and publisher must match. If the value is empty or , any match is allowed. Example: Publisher Name: Product Name: Huawei Process Name: * A product whose name is Huawei is considered a match.
path_rule	No	PathRule object	Path rule information, which restricts the corresponding path and subpath.

**Table 5** ProductRule
Parameter	Mandatory	Type	Description
identify_condition	No	String	Identification condition.
publisher	No	String	Publisher name: Contains visible characters or spaces but cannot contain only spaces. Contains 0 to 1,024 characters. If the value is empty or *, any match is supported.
product_name	No	String	Product name: Contains visible characters or spaces but cannot contain only spaces. Contains 0 to 128 characters. If the value is empty or *, any match is supported.
process_name	No	String	Process name: Contains visible characters or spaces but cannot contain only spaces. Contains 0 to 128 characters. If the value is empty or *, any match is supported.
support_os	No	String	OS type. This field exists only for built-in rules. Contains visible characters or spaces but cannot contain only spaces. Contains 0 to 128 characters.
version	No	String	Version: Contains visible characters or spaces but cannot contain only spaces. Contains 0 to 128 characters. If the value is empty or *, any match is supported.
product_version	No	String	Product version: Contains visible characters. Contains 0 to 128 characters.

**Table 6** PathRule
Parameter	Mandatory	Type	Description
path	No	String	Complete path: Contains visible characters or spaces but cannot contain only spaces. Contains 0 to 512 characters.

Response Parameters

Status code: 200

**Table 7** Response body parameters
Parameter	Type	Description
id	String	Rule ID.
name	String	Rule name.
description	String	Rule description.
rule	Rule object	Rule information.
rule_source	String	Rule source.
create_time	DateTime	Creation time.
update_time	DateTime	Update time.

**Table 8** Rule
Parameter	Type	Description
scope	String	Application scope of a rule: PRODUCT: product PATH: path
product_rule	ProductRule object	Product rule information. The process name, product name, and publisher must match. If the value is empty or , any match is allowed. Example: Publisher Name: Product Name: Huawei Process Name: * A product whose name is Huawei is considered a match.
path_rule	PathRule object	Path rule information, which restricts the corresponding path and subpath.

**Table 9** ProductRule
Parameter	Type	Description
identify_condition	String	Identification condition.
publisher	String	Publisher name: Contains visible characters or spaces but cannot contain only spaces. Contains 0 to 1,024 characters. If the value is empty or *, any match is supported.
product_name	String	Product name: Contains visible characters or spaces but cannot contain only spaces. Contains 0 to 128 characters. If the value is empty or *, any match is supported.
process_name	String	Process name: Contains visible characters or spaces but cannot contain only spaces. Contains 0 to 128 characters. If the value is empty or *, any match is supported.
support_os	String	OS type. This field exists only for built-in rules. Contains visible characters or spaces but cannot contain only spaces. Contains 0 to 128 characters.
version	String	Version: Contains visible characters or spaces but cannot contain only spaces. Contains 0 to 128 characters. If the value is empty or *, any match is supported.
product_version	String	Product version: Contains visible characters. Contains 0 to 128 characters.

**Table 10** PathRule
Parameter	Type	Description
path	String	Complete path: Contains visible characters or spaces but cannot contain only spaces. Contains 0 to 512 characters.

Status code: 400

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 401

**Table 12** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 403

**Table 13** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 404

**Table 14** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 405

**Table 15** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 500

**Table 16** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Status code: 503

**Table 17** Response body parameters
Parameter	Type	Description
error_code	String	Error code, which is returned upon failure.
error_msg	String	Error message.

Example Requests

{
  "name" : "Huawei",
  "description" : "test",
  "rule" : {
    "scope" : "PRODUCT",
    "product_rule" : {
      "identify_condition" : "productName",
      "publisher" : null,
      "product_name" : "HUAWEI",
      "process_name" : "Huawei.exe",
      "support_os" : "Windows",
      "version" : "1.0.0.1",
      "product_version" : "1.0.0.1"
    },
    "path_rule" : {
      "path" : "D:\\\\tmp"
    }
  }
}

Example Responses

Status code: 200

Response to a successful request.

{
  "id" : "string",
  "name" : "string",
  "description" : "string",
  "rule" : {
    "scope" : "PRODUCT",
    "product_rule" : {
      "identify_condition" : "productName",
      "publisher" : null,
      "product_name" : "HUAWEI",
      "process_name" : "Huawei.exe",
      "support_os" : "Windows",
      "version" : "1.0.0.1",
      "product_version" : "1.0.0.1"
    },
    "path_rule" : {
      "path" : "D:\\\\tmp"
    }
  },
  "rule_source" : "string",
  "create_time" : "2024-12-25T07:03:30.065Z",
  "update_time" : "2024-12-25T07:03:30.065Z"
}

Status Codes

Status Code	Description
200	Response to a successful request.
400	The request cannot be understood by the server due to malformed syntax.
401	Authentication failed.
403	No operation permissions.
404	No resources found.
405	The method specified in the request is not allowed.
500	An internal service error occurred. For details, see the error code description.
503	Service unavailable.