DescribeRule - - Alibaba Cloud Documentation Center

Queries detailed information about a rule.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

GET /v2/openapi/instances/{instanceId}/rules/{ruleId}

Request parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The ID of the rule.	airec-cn-o400whm78004
ruleId	string	Yes	The ID of the scene.	xxx
sceneId	string	Yes	The type of the rule. Valid values: selection and operation.	xxx
ruleType	string	Yes	The returned result.	selection

Response parameters

Parameter	Type	Description	Example
	object
result	object	The ID of the rule.
ruleId	string	The time when the rule was last modified.	98493A14-D619-4E88-9F8D-108939817F9F
gmtModified	string	The state of the rule.	2020-04-27T06:38:28.000Z
status	string	The time when the rule was created.	DRAFT
gmtCreate	string	The error code.	2020-04-27T06:38:28.000Z
code	string	The ID of the request.	InternalServerError
requestId	string	The error message.	8F81A922-6C81-46D6-B78C-CC35E16B1691
message	string	null	An internal server error occurred

Examples

Sample success responses

JSONformat

{
  "result": {
    "ruleId": "98493A14-D619-4E88-9F8D-108939817F9F",
    "gmtModified": "2020-04-27T06:38:28.000Z",
    "status": "DRAFT",
    "gmtCreate": "2020-04-27T06:38:28.000Z"
  },
  "code": "InternalServerError",
  "requestId": "8F81A922-6C81-46D6-B78C-CC35E16B1691",
  "message": "An internal server error occurred"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history