DescribeInstance-阿里云帮助中心

Queries the information of an outbound robot business instance.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The instance ID.	af81a389-91f0-4157-8d82-720edd02b66a

Response elements

Element	Type	Description	Example
	object
HttpStatusCode	integer	The HTTP status code.	200
Code	string	The status code.	OK
Message	string	The response message.	Success
RequestId	string	The request ID.	254EB995-DEDF-48A4-9101-9CA5B72FFBCC
Success	boolean	Indicates whether the request was successful.	true
Instance	object	The business instance information.
CreationTime	integer	The creation time.	1578469042851
InstanceId	string	The business instance ID.	90515b5-6115-4ccf-83e2-52d5bfaf2ddf
CreatorId	integer	The creator ID.	435986
OwnerName	string	The name of the business instance owner.	xxxx
InstanceDescription	string	The description of the business instance.	This is the first instance
InstanceName	string	The name of the business instance.	First instance
CreatorName	string	The name of the creator.	xxx
ResourceGroupId	string	The resource group ID.	90515b5-6115-4ccf-83e2-52d5bfaf2ddf
MaxConcurrentConversation	integer	The maximum concurrency of the instance.	4

Examples

Success response

JSON format

{
  "HttpStatusCode": 200,
  "Code": "OK",
  "Message": "Success",
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC",
  "Success": true,
  "Instance": {
    "CreationTime": 1578469042851,
    "InstanceId": "90515b5-6115-4ccf-83e2-52d5bfaf2ddf",
    "CreatorId": 435986,
    "OwnerName": "xxxx",
    "InstanceDescription": "这个是第一个实例",
    "InstanceName": "第一个实例",
    "CreatorName": "xxx",
    "ResourceGroupId": "90515b5-6115-4ccf-83e2-52d5bfaf2ddf",
    "MaxConcurrentConversation": 4
  }
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.