URL Risk Detection API (Synchronous)

Get started

1. Create an Alibaba Cloud account. If you do not have one, Sign up and complete the registration process.

2. Activate Content Moderation. Make sure you Activate Service. Activation is free. After you start making API calls, you are billed on a pay-as-you-go basis. For more information, see URL Risk Detection and billing. You can also purchase a resource package. Resource packages offer tiered pricing and are recommended for users with predictable or high-volume usage.

3. Create an AccessKey. Ensure you have an AccessKey. If you use an AccessKey that belongs to a RAM user, you must grant the AliyunYundunGreenWebFullAccess permission to the RAM user from your Alibaba Cloud account. For details, see RAM authorization.

4. Start development. We recommend using an SDK to call the API. For more information, see the Developer guide.

Usage

You can call this operation to check URLs for risks. For information about how to construct HTTP requests, see HTTPS-based API calls. You can also use pre-configured requests. For more information, see the Developer guide.

• Operation name: TextModeration

• Supported regions and endpoints:

  Region	Public endpoint	Internal endpoint
  China (Shanghai)	https://green-cip.cn-shanghai.aliyuncs.com	https://green-cip-vpc.cn-shanghai.aliyuncs.com
  China (Hangzhou)	https://green-cip.cn-hangzhou.aliyuncs.com	https://green-cip-vpc.cn-hangzhou.aliyuncs.com
  China (Beijing)	https://green-cip.cn-beijing.aliyuncs.com	https://green-cip-vpc.cn-beijing.aliyuncs.com
  China (Shenzhen)	https://green-cip.cn-shenzhen.aliyuncs.com	Not available
  China (Chengdu)	https://green-cip.cn-chengdu.aliyuncs.com	Not available

• Billing:

  This is a billable operation. Only requests with an HTTP status code of 200 are metered and billed. Requests that return other status codes are not billed. For more information about billing, see URL Risk Detection and billing.

• URL format:

  The URL risk detection service supports URLs in the following format: http(s)://{IP or domain name}{:port}{/path}

  Note

  1. The URL prefix (http:// or https://) is optional.

  2. The domain name must consist of alphanumeric characters and periods (.). The top-level domain must be two to six characters long.

  3. The port must be a one- to four-digit number.

  4. The path supports digits, letters, and common characters such as _!~*'().;?:@&=+$,%#-). It does not support Chinese characters.

  The API returns the BAD_REQUEST(400) error code for URLs that do not match this format.

QPS limits

The queries per second (QPS) limit for this operation is 100 for a single user. If you exceed this limit, the system throttles your API calls, which may affect your business.

Debug the API

Before integration, you can use OpenAPI Explorer to test Content Moderation-Enhanced, view sample code and SDK dependencies, and get an overview of how to use the operation and its parameters.

Request parameters

Response parameters

Examples

Sample request

{
    "Service": "url_detection",
    "ServiceParameters": "{\"content\":\"http://aliyun.com/abc\",\"accountId\":\"10123****\"}"
}

Sample response

{
    "Code": 200,
    "Data": {
        "Labels": "unmarked_url",
        "Reason": "{\"icpType\":\"Enterprise\",\"icpNo\":\"ICP123XXXX789\",\"score\":\"60\"}"
    },
    "Message": "OK",
    "RequestId": "AAAAAA-BBBB-CCCCC-DDDD-EEEEEEEE****"
}

Status codes

The following table describes the API status codes. You are billed only for requests that return a status code of 200.