{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/cloud:aliyun-wss/create-multi-order":{"post":{"operationId":"cloud_aliyun_wss_create_multi_order","summary":"Creates an order, renews, or modifies the configuration of specific products such as the monthly duration…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://wss.ap-southeast-1.aliyuncs.com","https://wss.cn-shanghai.aliyuncs.com"],"default":"https://wss.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://wss.ap-southeast-1.aliyuncs.com"},"OrderItems":{"type":"string","description":"The product information (JSON-encoded)"},"OrderType":{"type":"string","description":"The order type"},"Properties":{"type":"string","description":"The extended properties (JSON-encoded)"},"ResellerOwnerUid":{"type":"integer","description":"The ID of the actual end user. This parameter is required when a reseller partner places an order"},"ChannelCookie":{"type":"string","description":"The cookie information used for channel attribution. Specify this parameter if channel attribution information exists. Otherwise, you can…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-wss/describe-credit-package-agents":{"post":{"operationId":"cloud_aliyun_wss_describe_credit_package_agents","summary":"Queries the list of agents and usage summary information under the current username","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://wss.ap-southeast-1.aliyuncs.com","https://wss.cn-shanghai.aliyuncs.com"],"default":"https://wss.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://wss.ap-southeast-1.aliyuncs.com"},"BizType":{"type":"string","description":"The business type"},"AgentType":{"type":"string","description":"The agent type. Valid values: `CREDIT_PACKAGE`, `JVS_CLAW`, `OPEN_CLAW`, and `JVS_COPILOT`"},"AgentIds":{"type":"string","description":"A JSON string of the AgentId list. Example: `[\"agent-1\",\"agent-2\"]` (JSON-encoded)"},"MaxResults":{"type":"integer","description":"The number of entries per page"},"NextToken":{"type":"string","description":"The pagination token. Set this parameter to an empty string for the first request. For subsequent requests, use the `nextToken` value from…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-wss/describe-credit-usage-info":{"post":{"operationId":"cloud_aliyun_wss_describe_credit_usage_info","summary":"Queries the credit usage of users, credit packages, or agents based on a specified dimension","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://wss.ap-southeast-1.aliyuncs.com","https://wss.cn-shanghai.aliyuncs.com"],"default":"https://wss.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://wss.ap-southeast-1.aliyuncs.com"},"BizType":{"type":"string","description":"The business type"},"UsageType":{"type":"string","description":"The usage type. Valid values: User: Returns the used amount, remaining amount, and consumption trend of the currently active credit…"},"SceneType":{"type":"string","description":"The operator Scenarios type. Valid values: Not specified or NaturalMonthlyOwn: Natural monthly exclusive. JzYearlyShare: Jz annual shared.…"},"InstanceIds":{"type":"string","description":"The JSON string of the instance ID list. This parameter can be omitted when `UsageType` is set to `User`. Set it to the credit package…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-wss/describe-deduction-statistic":{"post":{"operationId":"cloud_aliyun_wss_describe_deduction_statistic","summary":"Retrieves resource deduction and usage statistics based on specified conditions","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://wss.ap-southeast-1.aliyuncs.com","https://wss.cn-shanghai.aliyuncs.com"],"default":"https://wss.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://wss.ap-southeast-1.aliyuncs.com"},"Periods":{"type":"string","description":"The list of time periods in JSON array format. Each element is a `PeriodParam` object (JSON-encoded)"},"ResourceTypes":{"type":"string","description":"The list of resource types in JSON array format (JSON-encoded)"},"StartTime":{"type":"integer","description":"The start time of the query. UNIX timestamp, in milliseconds"},"EndTime":{"type":"integer","description":"The end time of the query. UNIX timestamp, in milliseconds"},"InstanceIds":{"type":"string","description":"The list of instance IDs in JSON array format (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-wss/describe-delivery-address":{"post":{"operationId":"cloud_aliyun_wss_describe_delivery_address","summary":"Retrieves information about delivery addresses","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://wss.ap-southeast-1.aliyuncs.com","https://wss.cn-shanghai.aliyuncs.com"],"default":"https://wss.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://wss.ap-southeast-1.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-wss/describe-groups":{"post":{"operationId":"cloud_aliyun_wss_describe_groups","summary":"Queries deduction group information","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["GroupType"],"properties":{"endpoint":{"type":"string","enum":["https://wss.ap-southeast-1.aliyuncs.com","https://wss.cn-shanghai.aliyuncs.com"],"default":"https://wss.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://wss.ap-southeast-1.aliyuncs.com"},"GroupType":{"type":"string","description":"The group type"},"NextToken":{"type":"string","description":"The pagination token. Leave this parameter empty for the first request. For subsequent requests, set this parameter to the nextToken value…"},"MaxResults":{"type":"string","description":"The number of entries per page"},"States":{"type":"string","description":"The list of states (JSON-encoded)"},"ResourceIds":{"type":"string","description":"The list of resource IDs (JSON-encoded)"},"StartTime":{"type":"integer","description":"The start time of the period"},"EndTime":{"type":"integer","description":"The end time of the period"},"GroupResourceTypes":{"type":"string","description":"The list of group resource types (JSON-encoded)"},"TimeUsingPeriod":{"type":"string","description":"Specifies whether to query by effective period"},"InstanceIds":{"type":"string","description":"The Lingxiao instance ID (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-wss/describe-multi-price":{"post":{"operationId":"cloud_aliyun_wss_describe_multi_price","summary":"Queries the prices of Elastic Desktop Service products for order types such as new purchases, renewals,…","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://wss.ap-southeast-1.aliyuncs.com","https://wss.cn-shanghai.aliyuncs.com"],"default":"https://wss.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://wss.ap-southeast-1.aliyuncs.com"},"OrderItems":{"type":"string","description":"The product information (JSON-encoded)"},"OrderType":{"type":"string","description":"The order type"},"PackageCode":{"type":"string","description":"The package code. You do not need to specify this parameter for non-package types"},"ResellerOwnerUid":{"type":"integer","description":"The user ID for resource ownership in the reseller pattern. You do not need to specify this parameter for non-reseller patterns"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-wss/describe-package-deductions":{"post":{"operationId":"cloud_aliyun_wss_describe_package_deductions","summary":"Queries the deduction details of core-hour packages","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://wss.ap-southeast-1.aliyuncs.com","https://wss.cn-shanghai.aliyuncs.com"],"default":"https://wss.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://wss.ap-southeast-1.aliyuncs.com"},"ResourceType":{"type":"string","description":"The resource type"},"PackageIds":{"type":"string","description":"The list of core-hour package IDs in JSON format (JSON-encoded)"},"InstanceIds":{"type":"string","description":"The list of cloud desktop IDs. If this field is specified, the PackageIds field is required (JSON-encoded)"},"PageNum":{"type":"integer","description":"The current page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page set in the paging Settings during a paged query. Maximum value: 100"},"StartTime":{"type":"integer","description":"The start time of the query. Use a UNIX timestamp in milliseconds"},"EndTime":{"type":"integer","description":"The end time of the query. Use a UNIX timestamp in milliseconds"},"ResourceTypes":{"type":"string","description":"The array of resource types (JSON-encoded)"},"InstanceId":{"type":"string","description":"The instance ID, such as ecd-xxx"},"InstanceIdType":{"type":"string","description":"The instance ID type"},"GroupResourceTypes":{"type":"string","description":"The list of resource group types (JSON-encoded)"},"AgentTypes":{"type":"string","description":"The list of agent types (JSON-encoded)"},"AgentType":{"type":"string","description":"The agent type"},"RunId":{"type":"string","description":"The run ID"},"RunIdList":{"type":"string","description":"The list of run IDs (JSON-encoded)"},"DeductionTypes":{"type":"string","description":"The deduction types (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-wss/describe-run-id-deductions":{"post":{"operationId":"cloud_aliyun_wss_describe_run_id_deductions","summary":"Queries AI credit deductions","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://wss.ap-southeast-1.aliyuncs.com","https://wss.cn-shanghai.aliyuncs.com"],"default":"https://wss.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://wss.ap-southeast-1.aliyuncs.com"},"ResourceType":{"type":"string","description":"The resource type"},"InstanceIds":{"type":"string","description":"The list of cloud computer IDs. If this parameter is specified, the `PackageIds` parameter is required (JSON-encoded)"},"PageNum":{"type":"integer","description":"The page number. Default value: 1"},"PageSize":{"type":"integer","description":"The number of entries per page for a paged query"},"StartTime":{"type":"integer","description":"The start time of the query. This value is a UNIX timestamp. Unit: milliseconds"},"EndTime":{"type":"integer","description":"The end time of the query. This value is a UNIX timestamp. Unit: milliseconds"},"AliUid":{"type":"integer","description":"The Alibaba Cloud UID"},"PackageIds":{"type":"string","description":"The list of core-hour package IDs in JSON format (JSON-encoded)"},"MaxResults":{"type":"integer","description":"The number of entries per page"},"NextToken":{"type":"string","description":"The pagination token. Leave this parameter empty for the first request. For subsequent requests, use the `nextToken` value from the…"},"ResourceTypes":{"type":"string","description":"The list of resource types in JSON array format (JSON-encoded)"},"InstanceIdType":{"type":"string","description":"The instance ID type. Do not specify this parameter for non-knowledge base scenarios"},"BizType":{"type":"string","description":"The business type"},"GroupSeparator":{"type":"string","description":"Specifies whether to group results by deduction type"},"AgentType":{"type":"string","description":"The agent type. Valid values: `CREDIT_PACKAGE`, `JVS_CLAW`, `OPEN_CLAW`, and `JVS_COPILOT`"},"DeductionTypes":{"type":"string","description":"The deduction types. Do not specify this parameter for non-knowledge base scenarios (JSON-encoded)"},"WyId":{"type":"string","description":"The WyId"},"GroupResourceTypes":{"type":"string","description":"The GroupResourceTypes (JSON-encoded)"},"GroupByFields":{"type":"string","description":"The GroupByFields (JSON-encoded)"},"AgentTypes":{"type":"string","description":"The AgentTypes (JSON-encoded)"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-wss/modify-instance-properties":{"post":{"operationId":"cloud_aliyun_wss_modify_instance_properties","summary":"Modifies the attributes of an instance","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ResourceType"],"properties":{"endpoint":{"type":"string","enum":["https://wss.ap-southeast-1.aliyuncs.com","https://wss.cn-shanghai.aliyuncs.com"],"default":"https://wss.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://wss.ap-southeast-1.aliyuncs.com"},"ResourceType":{"type":"string","description":"The resource type. This parameter is case-sensitive. Ensure correct spelling"},"InstanceId":{"type":"string","description":"The ID of the instance"},"Key":{"type":"string","description":"The key of the attribute"},"Value":{"type":"string","description":"The value of the attribute. PackageUsedUpStrategy: [enum] Postpaid (switches to the pay-as-you-go billing method) Shutdown (hibernates or…"},"InstanceIds":{"type":"string","description":"The instance IDs (JSON-encoded)"},"Properties":{"type":"string","description":"The list of instance attributes to modify. You can modify multiple key-value pairs at a time. These pairs are merged with the original Key…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-wss/set-agent-credit-quota":{"post":{"operationId":"cloud_aliyun_wss_set_agent_credit_quota","summary":"Sets the credit usage quota for a specified Agent","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://wss.ap-southeast-1.aliyuncs.com","https://wss.cn-shanghai.aliyuncs.com"],"default":"https://wss.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://wss.ap-southeast-1.aliyuncs.com"},"BizType":{"type":"string","description":"The business type"},"AgentType":{"type":"string","description":"The Agent type"},"AgentIds":{"type":"string","description":"The list of Agent IDs (JSON-encoded)"},"CreditQuota":{"type":"integer","description":"The credit quota"},"SceneType":{"type":"string","description":"The operator scenarios type. Valid values: If this parameter is not specified or is set to NaturalMonthlyOwn: calendar month exclusive.…"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-wss/version":{"post":{"operationId":"cloud_aliyun_wss_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://wss.ap-southeast-1.aliyuncs.com","https://wss.cn-shanghai.aliyuncs.com"],"default":"https://wss.ap-southeast-1.aliyuncs.com","description":"Regional endpoint, for example https://wss.ap-southeast-1.aliyuncs.com"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}