West Cn API

West.cn (西部数码) API Skill

Overview

Interact with the West.cn (西部数码) business API v2 to manage domains, DNS records, cloud servers, virtual hosting, SSL certificates, enterprise email, and billing.

Authentication

All API calls require a token parameter for identity verification.

Token generation

token = md5(username + api_password + timestamp)

• username: West.cn registered username
• api_password: API password (configurable in the West.cn management console)
• timestamp: Current millisecond timestamp
• MD5 output: 32-char lowercase hex string
• Token validity: 10 minutes

Shell helper to generate token

USERNAME="<your_username>"
API_PASSWORD="<your_api_password>"
TIMESTAMP=$(python3 -c "import time; print(int(time.time()*1000))")
TOKEN=$(echo -n "${USERNAME}${API_PASSWORD}${TIMESTAMP}" | md5)
echo "token=$TOKEN&username=$USERNAME&timestamp=$TIMESTAMP"

Base URL

https://api.west.cn/api/

Common request pattern

• POST requests: Content-Type: application/x-www-form-urlencoded
  • Body params: act=<action>&token=<token>&username=<username>&timestamp=<timestamp>&...
• GET requests: Query params: ?act=<action>&token=<token>&username=<username>&timestamp=<timestamp>&...

Common response format

{
  "result": 200,
  "clientid": "<request_tracking_id>",
  "data": { ... }
}

• result: 200 = success, other values = error (see error codes)
• clientid: Request tracking ID
• data: Business-specific response data

API Endpoint Reference

1. Domain Business (域名业务)

Base path: v2/domain/

1.1 Domain Pricing

1.2 Template & Real-name (模板实名)

1.3 Domain Query & Registration (域名查询及注册)

1.4 Domain Management (域名管理)

1.5 Domain Renewal (域名续费)

1.6 Domain DNS Operations (域名DNS操作)

1.7 DNSSEC

1.8 Domain Resolution (域名解析)

DNS Record Types: A, CNAME, MX, TXT, AAAA, SRV

DNS Line Values:

• Default: "" (empty)
• China Telecom: LTEL
• China Unicom: LCNC
• China Mobile: LMOB
• Education Network: LEDU
• Search Engine: LSEO

TTL: 60-86400 seconds (default 900) Level (MX priority): 1-100 (default 10)

1.9 Domain Certificate (域名证书)

1.10 Domain Password (域名管理密码)

1.11 Smart DNS (智能DNS)

1.12 CNNIC Privacy Protection

2. Server Business (服务器业务)

Base path: v2/server/

2.1 Configuration

2.2 Provisioning & List

2.3 Renewal & Conversion

2.4 Upgrade & Migration

2.5 System & Logs

2.6 Security Groups (安全组)

2.7 Virtual Switch (虚拟交换机)

2.8 CC Protection (CC防护)

Server cluster IDs:

3. Virtual Hosting (虚拟主机业务)

Base path: v2/host/ (POST unless noted)

3.1 Provisioning

3.2 Domain Binding

3.3 Sub-site Management

3.4 File Management

3.5 Security

4. Enterprise Email (企业邮箱业务)

Base path: v2/mail/ (POST)

5. SSL Certificate (SSL证书业务)

Base path: v2/ssl/ (POST)

Provisioning and management of SSL certificates (specific actions available in full API docs).

6. Mini Program (小程序业务)

Base path: v2/miniapp/

7. MSSQL Database (mssql数据库)

Base path: v2/mssql/ (POST)

8. Domain Auction & Buy-Now (域名抢注及一口价)

Base path: v2/domain/ or v2/auction/

9. Finance & Invoicing (财务及发票功能)

Base path: v2/info/ (POST)

Invoice (base path: v2/invoice/, GET):

10. Other (其他业务及功能)

ICP Filing (备案):

Usage Examples

Example 1: Get domain list

BASE="https://api.west.cn/api"
# Generate token first (see Authentication section)

curl -G "${BASE}/v2/domain/" \
  --data-urlencode "act=getdomains" \
  --data-urlencode "token=${TOKEN}" \
  --data-urlencode "username=${USERNAME}" \
  --data-urlencode "timestamp=${TIMESTAMP}" \
  --data-urlencode "limit=20" \
  --data-urlencode "page=1"

Example 2: Add DNS A record

curl -X POST "${BASE}/v2/domain/" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "act=adddnsrecord" \
  -d "token=${TOKEN}" \
  -d "username=${USERNAME}" \
  -d "timestamp=${TIMESTAMP}" \
  -d "domain=example.com" \
  -d "host=www" \
  -d "type=A" \
  -d "value=1.2.3.4" \
  -d "ttl=900" \
  -d "level=10" \
  -d "line="

Example 3: Get server list

curl -X POST "${BASE}/v2/server/" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "act=list" \
  -d "token=${TOKEN}" \
  -d "username=${USERNAME}" \
  -d "timestamp=${TIMESTAMP}" \
  -d "pageno=1" \
  -d "limit=20"

Example 4: Check account balance

curl -X POST "${BASE}/v2/info/" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "act=checkbalance" \
  -d "token=${TOKEN}" \
  -d "username=${USERNAME}" \
  -d "timestamp=${TIMESTAMP}"

Example 5: Get DNS records for a domain

curl -X POST "${BASE}/v2/domain/" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "act=getdnsrecords" \
  -d "token=${TOKEN}" \
  -d "username=${USERNAME}" \
  -d "timestamp=${TIMESTAMP}" \
  -d "domain=example.com"

Important Notes

• Always pass token, username, and timestamp with every request
• Token expires after 10 minutes; regenerate before each call
• For POST requests, use application/x-www-form-urlencoded content type
• The act parameter determines the specific operation within each endpoint path
• Server IDs (id) are critical and should be stored locally
• After IP changes, the only way to get the new IP is via the server ID

Error Handling

• result: 200 = success
• Other result codes indicate errors; check the error code documentation
• Common issues: expired token, insufficient balance, invalid parameters