AssociateSecurityGroups

Prev Next

search by keyword

Recent Pages

Documentation

Download PDF

Last updated: 2021-12-01 10:57:53

Download PDF

1. API Description

Domain name for API request: mariadb.tencentcloudapi.com.

This API is used to associate security groups with Tencent Cloud resources in batches.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: AssociateSecurityGroups.
Version	Yes	String	Common parameter. The value used for this API: 2017-03-12.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
Product	Yes	String	Database engine name. Valid value: `mariadb`.
SecurityGroupId	Yes	String	ID of the security group to be associated in the format of sg-efil73jd.
InstanceIds.N	Yes	Array of String	ID(s) of the instance(s) to be associated in the format of tdsql-lesecurk. You can specify multiple instances.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1

Input Example

https://mariadb.tencentcloudapi.com/?Action=AssociateSecurityGroups
&Product=mariadb
&SecurityGroupId=sg-xxxxxx
&InstanceIds.0=tdsql-xxxxxx
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "8ce27ff0-7fe1-11ea-8469-525400542aa6"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.AddInstanceInfoFailed	Failed to add the security group information of an instance.
FailedOperation.AssociateSecurityGroupsFailed	Failed to associate the security group.
FailedOperation.AuthNoStrategy	Authentication failed.
FailedOperation.ClearInstanceInfoFailed	Failed to clear the security group information of an instance.
FailedOperation.DisassociateSecurityGroupsFailed	Failed to unassociate the security group.
FailedOperation.SetRuleLocationFailed	Failed to set a rule.
FailedOperation.UpdateInstanceInfoFailed	Failed to update the security group information of an instance.
InternalError.DBRowsAffectedError	No database data has changed.
InternalError.GetSecurityGroupDetailFailed	Failed to query security group details.
InternalError.GetUsgQuotaError	Failed to query the security group quota of the user.
InternalError.InsertFail	Failed to insert data into the database.
InternalError.InstanceOperatePermissionError	You have no permission to operate this instance.
InternalError.InstanceSGOverLimitError	The maximum number of security groups with which a single instance can associate has been reached.
InternalError.ListInstanceRespResourceCountNotMatchError	The number of resources returned is inconsistent with the number specified in the request of querying instance information.
InternalError.ListInstancesError	An error occurred when querying an instance.
InternalError.QueryDatabaseFailed	An error occurred when reading data from the database.
InternalError.ReadDatabaseFailed	An error occurred when reading data from the database.
InternalError.SetSvcLocationFailed	The security group policy of the resource failed to take effect.
InternalError.UpdateDatabaseFailed	Failed to update the database.
InvalidParameter	Parameter error.
InvalidParameter.IllegalParameterError	Invalid parameters
InvalidParameter.InstanceNotFound	Failed to find the requested instance.
InvalidParameter.PermissionDenied	You have no permission to manipulate this API or resource.
InvalidParameter.SGCheckFail	Security group validity test failed.
ResourceNotFound.ProductConfigNotExistedError	Failed to find the configuration of the product associated with the security group.
ResourceUnavailable.InstanceStatusAbnormal	Incorrect database instance status. Operations are not allowed.
UnauthorizedOperation.PermissionDenied	You have no permission to manipulate this API or resource.

Recent Pages