All Products
Search

This Product

    Chat App Message Service:QueryInstance

    Document Center

    Chat App Message Service:QueryInstance

    Last Updated:Mar 31, 2026

    Gets the details of a specified 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

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    cams:QueryInstance

    get

    *Instance

    acs:cams:{#regionId}:{#accountId}:instance/{#InstanceId}

    None

    None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example

    InstanceId

    string

    Yes

    The ID of the instance.

    9293938****

    Response elements

    Element

    Type

    Description

    Example

    object

    AccessDeniedDetail

    string

    The detailed reason for access denial.

    None

    Message

    string

    The response message.

    NULL

    RequestId

    string

    The ID of the request.

    29kskkd******

    Data

    object

    The data object returned on a successful request.

    CountryId

    string

    The country ID.

    Note

    For a list of country codes, see Country codes.

    1

    ContactMail

    string

    The contact email address.

    1@alibaba.com

    CustType

    string

    The customer type.

    01

    ResourceRegionId

    string

    The region ID of the resource.

    1

    ResourceGroupId

    string

    The ID of the resource group.

    111

    InstanceId

    string

    The ID of the instance.

    293939*****

    OfficeAddress

    string

    The office address.

    example

    SubmitTime

    string

    The submission time.

    140092992

    InstanceName

    string

    The name of the instance.

    viber_ins

    IsvTerms

    string

    The ISV terms.

    https://alibaba.com/1.pdf

    FacebookBmId

    string

    The Facebook Business Manager ID.

    39929****

    InstanceDescription

    string

    The description of the instance.

    ins

    ChannelType

    string

    The channel type.

    VIBER

    Code

    string

    The request status code.

    • OK indicates that the request was successful.

    • For other error codes, see Error code list.

    OK

    Success

    boolean

    Indicates whether the request was successful.

    • true: The request was successful.

    • false: The request failed.

    true

    Examples

    Success response

    JSON format

    {
  "AccessDeniedDetail": "None",
  "Message": "NULL",
  "RequestId": "29kskkd******",
  "Data": {
    "CountryId": "1",
    "ContactMail": "1@alibaba.com",
    "CustType": "01",
    "ResourceRegionId": "1",
    "ResourceGroupId": "111",
    "InstanceId": "293939*****",
    "OfficeAddress": "example",
    "SubmitTime": "140092992",
    "InstanceName": "viber_ins",
    "IsvTerms": "https://alibaba.com/1.pdf",
    "FacebookBmId": "39929****",
    "InstanceDescription": "ins",
    "ChannelType": "VIBER"
  },
  "Code": "OK",
  "Success": true
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.