CreateServiceEntry-阿里云帮助中心

Add application entries to the service list to enable per-application statistics.

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:CreateServiceEntry

create

*CloudConnector

acs:iotcc:{#regionId}:{#accountId}:cloudconnector/{#IoTCloudConnectorId}

None

Request parameters

Parameter	Type	Required	Description	Example
ServiceId	string	Yes	The ID of the service for application-specific statistics. This ID is globally unique.	c910061f-**-44e6-b659-*c
IoTCloudConnectorId	string	Yes	The ID of the IoT Cloud Connector instance.	iotcc-bp1odcab8tmno0hdq****
Target	string	Yes	The destination address of the application entry.	192.168.1.32/27
TargetType	string	Yes	The type of the destination address for the application entry. Valid values: Cidr: A CIDR block. Domain: A domain name.	Cidr
ServiceEntryName	string	No	The name of the application entry. The name must be 2 to 128 characters in length and must start with a letter or a Chinese character. It can contain digits, periods (.), underscores (_), and hyphens (-).	entry_name
ServiceEntryDescription	string	No	The description of the application entry. The description must be 2 to 256 characters in length and must start with a letter or a Chinese character. It cannot start with `http://` or `https://`.	entry_description
ClientToken	string	No	A client token used to ensure the idempotence of the request. This token is generated by the client and must be unique for each request. The token can contain a maximum of 64 ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	123e4567-e89b-12d3-a456-426655440000
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Sends a check request without adding the application entry. The system checks if required parameters are provided, the request format, and business limits. If the check fails, the corresponding error is returned. If the check passes, the error code `DryRunOperation` is returned. false (default): Sends a normal request. After the check passes, an HTTP 2xx status code is returned and the application entry is added.	false
RegionId	string	Yes	The ID of the region where the application entry is located. You can call the ListRegions operation to obtain the region ID.	cn-hangzhou

Response elements

Element	Type	Description	Example
	object	Request ID.
RequestId	string	The request ID.	54B48E3D-DF70-471B-AA93-08E683A1B45
ServiceEntryId	string	The ID of the application entry.	fwd-119smw5tkasdf****

Examples

Success response

JSON format

{
  "RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "ServiceEntryId": "fwd-119smw5tkasdf****"
}

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.