DocsICP FilingConsole
Documentation

CreateInstance

Updated at:
Copy as MD
Product
My Favorites

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 None

Request parameters

Parameter

Type

Required

Description

Example
ChannelType

string

Yes

The channel type.

Important The Singapore site supports all channels, and the Germany site currently supports only WhatsApp.

Valid values:

  • VIBER :

    VIBER

  • INSTAGRAM :

    INSTAGRAM

  • LINE :

    LINE

  • WHATSAPP :

    WHATSAPP

  • MESSENGER :

    MESSENGER

  • TELEGRAM :

    TELEGRAM

VIBER
InstanceName

string

Yes

The instance name.

viber_ins
InstanceDescription

string

No

The instance description.

ins
ResourceGroupId

string

No

The ID of the resource group to which the instance belongs.

example
OfficeAddress

string

No

The enterprise address.

example
ContactMail

string

No

The contact email address.

example
CountryId

string

No

The country code.

1
FacebookBmId

string

No

FacebookBmId

393992929
IsvTerms

string

No

The name of the ISV/client agreement file.

https://a.com/1.pdf
IsConfirmAudit

string

No

Specifies whether the audit is confirmed.

Y

Response elements

Element

Type

Description

Example

object

AccessDeniedDetail

string

The details of the access denial.

None
RequestId

string

The request ID.

2992939*****
Message

string

The error message.

NULL
Data

object

The returned data.

InstanceName

integer

The instance name.

ins
ResourceRegionId

string

The region to which the resource belongs.

example
InstanceId

string

The instance ID.

2999292
InstanceDescription

string

The instance description.

des
SubmitTime

string

The submission time.

example
ChannelType

string

The channel type.

example
Code

string

The status code. A value of 200 indicates success.

OK
Success

boolean

Specifies whether the request is successful. Valid values:

  • true: The request is successful.

  • false: The request fails.

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.