Querying Rule Details

project_id

Yes

String

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

instance_id

Yes

String

Gateway ID, which can be obtained from the gateway information on the APIG console.

orchestration_id

Yes

String

Orchestration rule ID.

X-Auth-Token

Yes

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 a token.

orchestration_name

String

Orchestration mapping rule name.

The name must be 3 to 64 characters long, start with a letter and use only letters, digits, and underscores (_). It must be unique in the same gateway.

Minimum: 3

Maximum: 64

orchestration_strategy

String

Orchestration policy. Options:

• list

• hash

• range

• hash_range

• none_value

• default

• head_n

• tail_n.

  If the orchestration policy is list, the number of objects in orchestration_map multiplied by that in map_param_list cannot exceed 3,000.

orchestration_mapped_param

OrchestrationMappedParam object

Parameter configuration after orchestration. This parameter is mandatory when isPreprocessing is set to false.

is_preprocessing

Boolean

Indicates whether the policy is a preprocessing policy. A preprocessing policy generates only temporary parameters as the input of the subsequent parameter orchestration rule. And it cannot be used as the last orchestration rule except the default orchestration rule.

orchestration_map

Array of OrchestrationMap objects

List of orchestration mapping rules. The list contains 1 to 300 characters.

Orchestration mapping rules are prioritized in the same sequence as the the list.

Mapping rules must be unique. If orchestration_strategy is list, map_param_list cannot contain same elements.

Array Length: 1 - 300

orchestration_id

String

Orchestration rule ID.

orchestration_create_time

String

Time when an orchestration rule was created.

orchestration_update_time

String

Time when an orchestration rule was updated.

mapped_param_name

String

Name of the request parameter after orchestration. The value can contain 1 to 128 characters, including letters, digits, and hyphens (-). It must start with a letter and cannot be the same as an existing parameter name. By default, the parameter name is transparently transmitted to the backend.

Minimum: 1

Maximum: 128

mapped_param_type

String

Type of the parameter after orchestration. The value can be string or number.

mapped_param_location

String

Position of the orchestrated parameter. The value can be query or header.

map_param_list

Array of strings

List of parameters after mapping orchestration. This parameter is mandatory when orchestration_strategy is set to list. The list length ranges from 0 to 3000.

The value can contain 1 to 128 characters, including letters, digits, hyphens (-), and underscores (_).

Minimum: 1

Maximum: 128

Array Length: 0 - 3000

map_param_range

OrchestrationMapParamRange object

This parameter is for mapping range configurations of parameters after orchestration and is mandatory if orchestration_strategy is range or hash_range.

mapped_param_value

String

The parameter value after orchestration can contain 1 to 128 characters, including only letters and digits.

This parameter is optional only when orchestration_strategy is set to hash, head_n, or tail_n, or is_preprocessing is set to false.

Minimum: 0

Maximum: 128

intercept_length

Integer

Truncation length. The value ranges from 1 to 100. This parameter is mandatory when the policy type is head_n or tail_n. If the truncation length is greater than the parameter length, the parameter truncation result is a complete parameter.

Minimum: 1

Maximum: 100

range_start

String

Range start value. The value is a string that can be converted to an integer. After the conversion, the value of range_start ranges from 0 to 9223372036854775807. And the value of range_start cannot be greater than that of range_end.

range_end

String

Range end value. The value is a string that can be converted to an integer. After the conversion, the value of range_end ranges from 0 to 9223372036854775807. And the value of range_start cannot be greater than that of range_end.

error_code

String

Error code.

error_msg

String

Error description.

error_code

String

Error code.

error_msg

String

Error description.

error_code

String

Error code.

error_msg

String

Error description.

error_code

String

Error code.

error_msg

String

Error description.

error_code

String

Error code.

error_msg

String

Error description.

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error