All Products
Document Center

Bind an IP access control to APIs (SetIpControlApis)

Last Updated: Feb 25, 2018


Bind a specified IP access control to APIs.

  • This function is intended for open API users.
  • It is used to bind an IP access control to APIs. Batch binding is supported, and a maximum of 100 APIs can be bound to an IP access control.

Request parameters

Parameter Type Required Description
Action String Yes Operation interface name, a required parameter, value: SetIpControlApis
IpControlId String Yes ID of the IP access control to be bound
GroupId String Yes Group ID of the APIs to be bound
ApiIds String Yes IDs of APIs to be bound. If multiple API IDs are input, they must be separated by a comma (,). A maximum of 100 API IDs can be entered.
StageName String Yes Environment where the specified APIs are used
  • RELEASE: online environment
  • PRE: pre-release environment
  • TEST: test environment

Response parameters

Parameter Type Description
RequestId String ID of the current request


Sample request

  2. &IpControlId=dd05f1c54d6749eda95f9fa6d491449a
  3. &GroupId=0009db9c828549768a200320714b8930
  4. &ApiIds=3b81fd160f5645e097cc8855d75a1cf6,46fbb52840d146f186e38e8e70fc8c12
  5. &StageName=test
  6. &<Public Request Parameters>

Sample response

XML format

  1. <SetSignatureApisResponse>
  2. <RequestId>CEF72CEB-54B6-4AE8-B225-F876FF7BZ004</RequestId>
  3. </SetSignatureApisResponse>

JSON format

  1. {
  2. "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BZ004"
  3. }