get https://{shopdomain}.myshoplaza.com/openapi/2022-01/data/task
Requires
read_dataaccess scope.
The App Proxy Details By ID API is used to retrieve detailed information about a specific APP_Proxy instance using its unique identifier.
This API is especially useful for:
- Checking the configuration of an existing app proxy.
- Verifying the
real_pathandproxy_urlmappings. - Auditing or debugging app proxy connections.
Request Parameters
Public Request Parameters
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
id | string | Yes | The unique identifier of the query task. If omitted, retrieves the latest query task. | d6ca13c4-43d9-4293-a124-c8bde3a3fa16 |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
query_id | string | The unique identifier of the query task. | d6ca13c4-43d9-4293-a124-c8bde3a3fa16 |
query_status | int | The status of the query task. (0 = Pending, 2 = Complete) | 2 |
| query | object | ||
query.url | string | The URL to access the query results. | https://shoplazza.oss-cn-shenzhen.aliyuncs.com/path/to/results.json |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
errors | Array | [ "no result"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | String | "page not found" | Indicates an error encountered during the process |
Error Detail
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized | |
| 404 | Not Found | the id is not found. | "no result" |