保存代理备注

POST/account/api/v1/proxies/note

授权

Authorization	`Bearer YOUR_ARNPROXY_API_KEY`
所需权限	`proxy_management`
Accept	`application/json`
Content-Type	`application/json`

参数

名称	类型	说明
`proxy_id` body必填	`integer`	自己的有效代理记录 ID，1–2147483647。
`note` body必填	`string`	去除首尾空格后最多 500 字符，且受查询响应中的存储限制。空文本清除备注。
`expected_revision` body必填	`string`	来自此操作范围/设置查询的 revision，64 个小写十六进制字符。

请求体

请用相应目录、报价或范围中的值替换 YOUR_/FROM_。示例中的确认值为 false；只有明确同意真实操作时才确认。

request.json

{
    "proxy_id": "YOUR_PROXY_ID",
    "note": "My application",
    "expected_revision": "FROM_PROXY_NOTE_REVISION"
}

请求示例

cURL

printf 'Authorization: Bearer %s\n' "$ARNPROXY_API_KEY" |
  curl --silent --show-error --header @- \
    --header 'Accept: application/json' \
    --connect-timeout 10 --max-time 30 \
    --request POST --header 'Content-Type: application/json' \
    --data-binary @request.json \
    'https://www.arnproxy.com/account/api/v1/proxies/note'

本页不会执行示例。请将 API 密钥保存在服务器环境变量中，不要放入 URL 或浏览器代码。POST 示例需准备 request.json。

响应

200成功响应

application/json

{
    "ok": true,
    "data": {
        "state": "completed",
        "changed": true,
        "provider_requests": 0,
        "proxy_id": 12345,
        "note": "Example label",
        "revision": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "note_update_available": true,
        "clear_with_empty_string": true,
        "source": "arnproxy_records",
        "maximum_length": 500,
        "maximum_utf8_bytes": 2000,
        "full_unicode_supported": true
    },
    "meta": {
        "request_id": "000000000000000000000001",
        "phase": "public_v1",
        "source": "arnproxy_records"
    }
}

响应字段与类型

名称	类型	说明
`ok`	`boolean`	成功标志；为 false 时请检查 error.code。
`data`	`object`	操作特定结果；示例均为演示用合成数据。
`data.state`	`string`	记录/操作状态。accepted 不表示已交付，completed 不表示连接测试成功。
`data.changed`	`boolean`	备注是否实际更改；false 可能表示所需文本已存在。
`data.provider_requests`	`integer`	provider requests 的操作特定值。请保留返回类型并查阅行为说明。
`data.proxy_id`	`integer`	相关 ARNPROXY 记录 ID，请勿替换为上游内部 ID。
`data.note`	`string`	note 的操作特定值。请保留返回类型并查阅行为说明。
`data.revision`	`string`	应原样返回至对应写操作/报价确认的新鲜度摘要。
`data.note_update_available`	`boolean`	note update available 的操作特定值。请保留返回类型并查阅行为说明。
`data.clear_with_empty_string`	`boolean`	clear with empty string 的操作特定值。请保留返回类型并查阅行为说明。
`data.source`	`string`	数据来源；本地记录与实时上游查询属于不同证据。
`data.maximum_length`	`integer`	maximum length 的操作特定值。请保留返回类型并查阅行为说明。
`data.maximum_utf8_bytes`	`integer`	maximum utf8 bytes 的操作特定值。请保留返回类型并查阅行为说明。
`data.full_unicode_supported`	`boolean`	full unicode supported 的操作特定值。请保留返回类型并查阅行为说明。
`meta`	`object`	请求关联与数据来源元信息。
`meta.request_id`	`string`	此 HTTP 请求的跟踪 ID，不是操作键或订单 ID。
`meta.phase`	`string`	phase 的操作特定值。请保留返回类型并查阅行为说明。
`meta.source`	`string`	数据来源；本地记录与实时上游查询属于不同证据。

错误响应

HTTP 401 · INVALID_API_KEY

{
  "ok": false,
  "error": { "code": "INVALID_API_KEY" },
  "meta": { "request_id": "000000000000000000000001" }
}

身份验证和参数校验可能在执行前拒绝请求。请查阅错误参考，联系支持时保留 request_id。切勿发送密钥或密码。错误与限制 →

行为与重要说明

使用客户面板现有代理备注字段，不发送至上游。最多 500 字符且受 GET 存储限制。note="" 清除。先从 proxy_note 获取 revision。文本相同返回 changed:false，旧 revision 不能覆盖不同文本。不需要 Idempotency-Key，结果不明确时先重新读取。