All Products
Search
Document Center

ApsaraVideo VOD:SetAuditSecurityIp

Last Updated:Mar 18, 2024

Manages the IP addresses in review security groups.

Operation description

Usage notes

You can play videos in the Checking or Blocked state only from the IP addresses that are added to review security groups.

QPS limits

You can call this operation up to 100 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits on API operations.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vod:SetAuditSecurityIpRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SecurityGroupNamestringNo

The name of the review security group. Default value: Default. You can specify a maximum of 10 review security groups.

Default
IpsstringYes

The IP addresses that you want to add to the review security group. You can add a maximum of 100 IP addresses to a review security group. Separate multiple IP addresses with commas (,). You can add IP addresses in the following formats to review security groups:

  • IP address: 192.168.0.1
  • CIDR block: 192.168.0.1/24. /24 indicates that the prefix of the CIDR block is 24 bits in length. You can replace 24 with a value that ranges from 1 to 32.
192.168.0.1
OperateModestringNo

The operation type. Valid values:

  • Append (default): adds the IP addresses to the original whitelist.
  • Cover: overwrites the original whitelist.
  • Delete: removes the IP addresses from the original whitelist.
Cover

Response parameters

ParameterTypeDescriptionExample
object

The returned results.

RequestIdstring

The ID of the request.

25818875-5F78-4AF6-D7393642CA58****

Examples

Sample success responses

JSONformat

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****"
}

Error codes

For a list of error codes, visit the Service error codes.

Common errors

The following table describes the common errors that this operation can return.

Error codeError messageHTTP status codeDescription
IpsIsEmptyThe specified "Ips" can not be empty.400The error message returned because the Ips parameter is not specified.
IpsExceededMaxThe specified Ips count has exceeded 100.403The error message returned because more than 100 IP addresses are added to a review security group.
SecurityIpGroupExceededMaxThe audit security group count has exceeded 10.403The error message returned because the number of review security groups exceeds the upper limit.