SetSniConfig - ApsaraMQ for MQTT - Alibaba Cloud Documentation Center

Configures a multi-domain certificate.

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

mq:SetSniConfig

update

*All Resource

*

None

mq:MqttInstanceAccess

Request parameters

Parameter	Type	Required	Description	Example
MqttInstanceId	string	Yes	The instance ID.	mqtt-cn-5yd3xxx
DefaultCertificate	string	Yes	The default certificate. This certificate is returned if no matching domain name is found in the server certificate list.	1533xxxx-cn-hangzhou
SniConfig	string	No	The Server Name Indication (SNI) configuration that maps domain names to certificates. Format: DomainName#CertificateID#Password(if any);DomainName#CertificateID#Password(if any)	*.mqtt.aliyuncs.com#15xxxxx-cn-hangzhou;mqtt-test.mqtt.aliyuncs.com#15xxxx9-cn-hangzhou

Response elements

Parameter	Type	Description	Example
	object	The response object.
RequestId	string	The ID of the request.	E4581CCF-62AF-44D9-B5B4-D1DQDC0E****
Success	string	Indicates whether the call was successful. A value of `true` indicates that the call was successful. A value of `false` indicates that the call failed.	True
AccessDeniedDetail	object	The details about the access denial.
AuthAction	string	The unauthorized operation that was attempted.	SetSniConfig
AuthPrincipalDisplayName	string	The display name of the authorization entity.	2063xxxxxxxx533
AuthPrincipalOwnerId	string	The ID of the Alibaba Cloud account that owns the authorization entity.	1245xxxxx34343
AuthPrincipalType	string	The type of the authorization entity.	SubUser
EncodedDiagnosticMessage	string	The encoded diagnostic information.	AQFma6gWZmuoFkMxQ0M3MUVCLTRFQzQtNTI1OS1BQ0Q0LTlBMTFGQkVDOTA3Qw==
NoPermissionType	string	The type of permission denial.	ImplicitDeny
PolicyType	string	The policy type.	AccountLevelIdentityBasedPolicy

Examples

Success response

JSON format

{
  "RequestId": "E4581CCF-62AF-44D9-B5B4-D1DQDC0E****",
  "Success": "True",
  "AccessDeniedDetail": {
    "AuthAction": "SetSniConfig",
    "AuthPrincipalDisplayName": "2063xxxxxxxx533",
    "AuthPrincipalOwnerId": "1245xxxxx34343",
    "AuthPrincipalType": "SubUser",
    "EncodedDiagnosticMessage": "AQFma6gWZmuoFkMxQ0M3MUVCLTRFQzQtNTI1OS1BQ0Q0LTlBMTFGQkVDOTA3Qw==",
    "NoPermissionType": "ImplicitDeny",
    "PolicyType": "AccountLevelIdentityBasedPolicy"
  }
}

Error codes

HTTP status code	Error code	Error message
400	MqttInstanceNotFound	Specified instance is not found
400	MqttOwnerCheckError	Failed to validate the instance permission
403	PermissionCheckFailed	Failed to verify API permissions.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.