CreateService-阿里云帮助中心

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

iotcc:CreateService

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
IoTCloudConnectorId	string	Yes	The ID of the IoT Cloud Connector instance.	iotcc-bp1odcab8tmno0hdq****
ServiceName	string	No	The name of the application-specific statistics service. The name must be 2 to 128 characters long. It must start with an English letter (uppercase or lowercase) or a Chinese character. It can contain numbers, periods (.), underscores (_), and hyphens (-).	service_name
ServiceDescription	string	No	The description of the application-specific statistics service. The description must be 2 to 256 characters long. It must start with an English letter (uppercase or lowercase) or a Chinese character. It cannot start with `http://` or `https://`.	service_description
ClientToken	string	No	The client token. Use it to ensure request idempotence. The client generates this parameter value. Ensure it is unique across different requests. The maximum length is 64 ASCII characters. Note If not specified, the system automatically uses the API request's RequestId as the ClientToken. The RequestId might differ for each API request.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	No	Check if this request is a dry run. Valid values: true: Send a check request. This does not create the service. The check includes required parameters, request format, and business limits. If the check fails, an error is returned. If the check passes, the `DryRunOperation` error code is returned. false (default): Send a normal request. If the check passes, an HTTP 2xx status code is returned, and the service is created directly.	false
RegionId	string	Yes	The region ID where the application-specific statistics service is located. For more information, see ListRegions.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	List of returned information.
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368
ServiceId	string	The ID generated by the system for the application-specific statistics service. It is unique across the entire network.	c910061f-**-44e6-b659-*c

Examples

Success response

JSON format

{
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368",
  "ServiceId": "c910061f-****-44e6-b659-***c"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Forbidden.RAM	Ram user does not have permission to perform this operation.	The error message returned because the RAM user does not have the permissions to perform the operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.