CreateInstance - Chat App Message Service - Alibaba Cloud Documentation Center

Creates an 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:CreateInstance

create

*Instance

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

None

Request parameters

Parameter	Type	Required	Description	Example
ChannelType	string	Yes	The channel type.	VIBER
InstanceName	string	Yes	The name of the instance.	viber_ins
InstanceDescription	string	No	The description of the instance.	ins
ResourceGroupId	string	No	The ID of the resource group that contains the instance.	example
OfficeAddress	string	No	The office address of the business.	example
ContactMail	string	No	The contact email address.	example
CountryId	string	No	The country code.	1
FacebookBmId	string	No	The ID of the Facebook Business Manager (BM).	393992929
IsvTerms	string	No	The URL of the ISV terms file.	https://a.com/1.pdf
IsConfirmAudit	string	No	Specifies whether to confirm the audit.	Y

Response elements

Element	Type	Description	Example
	object
AccessDeniedDetail	string	Details of the access denial.	None
RequestId	string	The unique ID of the request.	2992939*****
Message	string	The error message returned if the request fails.	NULL
Data	object	The returned data object.
InstanceName	integer	The name of the instance.	ins
ResourceRegionId	string	The ID of the region where the resource is located.	example
InstanceId	string	The ID of the instance.	2999292
InstanceDescription	string	The description of the instance.	des
SubmitTime	string	The time when the request was submitted.	example
ChannelType	string	The channel type.	example
Code	string	The response code. A value of `OK` indicates that the request was successful.	OK
Success	boolean	Indicates whether the request was successful. A value of `true` indicates success and `false` indicates failure.	false

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "RequestId": "2992939*****",
  "Message": "NULL",
  "Data": {
    "InstanceName": 0,
    "ResourceRegionId": "example",
    "InstanceId": "2999292",
    "InstanceDescription": "des",
    "SubmitTime": "example",
    "ChannelType": "example"
  },
  "Code": "OK",
  "Success": false
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.