ModifyInstance-阿里云帮助中心

Modifies an Outbound Bot 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

outboundbot:ModifyInstance

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	Yes	The ID of the Outbound Bot instance.	90515b5-6115-4ccf-83e2-52d5bfaf2ddf
InstanceName	string	No	The name of the instance.	新实例
InstanceDescription	string	No	The description of the instance.	这是新的实例
MaxConcurrentConversation	integer	Yes	The maximum number of concurrent conversations.	5
CallingNumber	array	No	A list of calling numbers. Note This parameter is optional.	["95187"]
	string	No	A calling number. Note This parameter is optional.	1**********

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 instance information.	{'InstanceId': 'ob369xifpi2074', 'AutoUpgradeObVersion': False}
CreationTime	integer	The creation time.	1578469042851
InstanceName	string	The name of the instance.	第一个实例
CreatorName	string	The name of the creator.	xxx
MaxConcurrentConversation	integer	The maximum number of concurrent conversations.	5
OwnerName	string	The name of the owner.	xxx
CreatorId	integer	The ID of the creator.	123123
InstanceId	string	The instance ID.	90515b5-6115-4ccf-83e2-52d5bfaf2ddf
InstanceDescription	string	The instance description.	这是第一个实例

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message
400	InvalidInstanceName.Duplicated	The specified InstanceName already exists.
400	LimitExceeded.ConcurrentConversation	The maximum number of concurrent conversations is exceeded.
500	InternalError	An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.
404	NotExist.Instance	The specified Instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.