DescribeJVSInstance - Cloud Phone - Alibaba Cloud Documentation Center

Retrieves details of JVS instances.

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 syntax

POST /anonymous/jvs/instance/describe HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
InstanceIds	array	No	A list of instance IDs.
	string	No	The instance ID.	acp-5hh431emkt6u*****
MaxResults	integer	No	The number of entries to return on each page.	10
NextToken	string	No	The pagination token from a previous request to retrieve the next page of results. Omit this parameter for the first request.	AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	425F351C-3F8E-5218-A520-B6311D0D****
MaxResults	integer	The number of entries returned on the current page.	10
NextToken	string	The token to retrieve the next page of results. If this field is empty, there are no more results.	AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****
TotalCount	integer	The total number of entries.	30
Data	array<object>	A list of JVS instances.
	array<object>	The details of a JVS instance.
InstanceId	string	The instance ID.	acp-uto81vfd8t8z****
CreditConfig	array<object>	The Credit limit configuration. If you apply multiple configurations, the latest one overwrites the others.
	object	The Credit limit configuration object.
CreditLimit	integer	The Credit limit. Valid values: 0 : Unavailable. >0 : The value specifies the limit. -1 : Unlimited.	-1
LimitPeriod	string	The limit period. Valid values: total : The total limit. month : The monthly limit. The usage is reset monthly on the same day the instance was activated. day : The daily limit. The usage is reset daily at 00:00.	day
UsedCredit	array<object>	The amount of used Credit.
	object
Credit	integer	The amount of Credit.	5
LimitPeriod	string	The calculation period for used Credit. Valid values: total : The total limit. month : The monthly limit. The usage is reset monthly on the same day the instance was activated. day : The daily limit. The usage is reset daily at 00:00.	day
JvsPackageId	string	This parameter is not supported.	null
Status	string	The instance status.	RUNNNING
CreateTime	string	The time the instance was created.	2026-04-10T01:31:32Z
ModifyTime	string	The time the instance was last modified.	2026-04-10T01:31:32Z
ExpireTime	string	The expiration time.	2026-04-10T01:31:32Z

Examples

Success response

JSON format

{
  "RequestId": "425F351C-3F8E-5218-A520-B6311D0D****",
  "MaxResults": 10,
  "NextToken": "AAAAAV3MpHK1AP0pfERHZN5pu6kU+SQXzm0H9mu/FiSc****",
  "TotalCount": 30,
  "Data": [
    {
      "InstanceId": "acp-uto81vfd8t8z****",
      "CreditConfig": [
        {
          "CreditLimit": -1,
          "LimitPeriod": "day"
        }
      ],
      "UsedCredit": [
        {
          "Credit": 5,
          "LimitPeriod": "day"
        }
      ],
      "JvsPackageId": "null",
      "Status": "RUNNNING",
      "CreateTime": "2026-04-10T01:31:32Z",
      "ModifyTime": "2026-04-10T01:31:32Z",
      "ExpireTime": "2026-04-10T01:31:32Z"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.