{"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-hcs-mgw/create-address":{"post":{"operationId":"cloud_aliyun_hcs_mgw_create_address","summary":"Creates a data address","description":"POST /address","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"},"ImportAddress":{"type":"object","description":"The details for creating the data address"}}}}}},"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-hcs-mgw/create-agent":{"post":{"operationId":"cloud_aliyun_hcs_mgw_create_agent","summary":"The request boy for creating the agent","description":"POST /agent","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"},"ImportAgent":{"type":"string","description":"The details for creating the agent"}}}}}},"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-hcs-mgw/create-job":{"post":{"operationId":"cloud_aliyun_hcs_mgw_create_job","summary":"Creates a migration task","description":"POST /job","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ImportJob"],"properties":{"endpoint":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"},"ImportJob":{"type":"object","description":"The details for creating the migration task"}}}}}},"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-hcs-mgw/create-report":{"post":{"operationId":"cloud_aliyun_hcs_mgw_create_report","summary":"Creates a migration report","description":"POST /report","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"},"CreateReport":{"type":"string","description":"The details for creating the migration report"}}}}}},"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-hcs-mgw/create-tunnel":{"post":{"operationId":"cloud_aliyun_hcs_mgw_create_tunnel","summary":"Creates a tunnel","description":"POST /tunnel","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"},"ImportTunnel":{"type":"string","description":"The details for creating the tunnel"}}}}}},"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-hcs-mgw/delete-address":{"post":{"operationId":"cloud_aliyun_hcs_mgw_delete_address","summary":"Deletes a data address","description":"DELETE /address/{addressName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["addressName"],"properties":{"endpoint":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"},"addressName":{"type":"string","description":"The name of the data address"}}}}}},"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-hcs-mgw/delete-agent":{"post":{"operationId":"cloud_aliyun_hcs_mgw_delete_agent","summary":"Deletes an agent","description":"DELETE /agent/{agentName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["agentName"],"properties":{"endpoint":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"},"agentName":{"type":"string","description":"The agent name"}}}}}},"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-hcs-mgw/delete-job":{"post":{"operationId":"cloud_aliyun_hcs_mgw_delete_job","summary":"Deletes a migration task","description":"DELETE /job/{jobName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jobName"],"properties":{"endpoint":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"},"forceDelete":{"type":"string","description":"Specifies whether to force delete the subtask. If the task has subtasks and you set this parameter to true, the task and its subtasks are…"},"jobName":{"type":"string","description":"The task name"}}}}}},"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-hcs-mgw/delete-tunnel":{"post":{"operationId":"cloud_aliyun_hcs_mgw_delete_tunnel","summary":"Deletes a tunnel","description":"DELETE /tunnel/{tunnelId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tunnelId"],"properties":{"endpoint":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"},"tunnelId":{"type":"string","description":"The tunnel ID"}}}}}},"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-hcs-mgw/get-address":{"get":{"operationId":"cloud_aliyun_hcs_mgw_get_address","summary":"Obtains the details of a data address","description":"GET /address/{addressName}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com","schema":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"}},{"name":"addressName","in":"query","required":true,"description":"The name of the data address","schema":{"type":"string","description":"The name of the data address"}}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-hcs-mgw/get-agent":{"get":{"operationId":"cloud_aliyun_hcs_mgw_get_agent","summary":"Obtains the details of an agent","description":"GET /agent/{agentName}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com","schema":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"}},{"name":"agentName","in":"query","required":true,"description":"The agent name","schema":{"type":"string","description":"The agent name"}}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-hcs-mgw/get-agent-status":{"get":{"operationId":"cloud_aliyun_hcs_mgw_get_agent_status","summary":"Obtains the running status of an agent","description":"GET /agent/{agentName}?status","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com","schema":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"}},{"name":"agentName","in":"query","required":true,"description":"The agent name","schema":{"type":"string","description":"The agent name"}}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-hcs-mgw/get-job":{"get":{"operationId":"cloud_aliyun_hcs_mgw_get_job","summary":"Retrieves the details of a migration task","description":"GET /job/{jobName}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com","schema":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"}},{"name":"byVersion","in":"query","required":false,"description":"Specifies whether to use the task ID for retrieval","schema":{"type":"string","description":"Specifies whether to use the task ID for retrieval"},"example":"false"},{"name":"jobName","in":"query","required":true,"description":"The task name. If byVersion is set to true, this parameter specifies the task ID","schema":{"type":"string","description":"The task name. If byVersion is set to true, this parameter specifies the task ID"}}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-hcs-mgw/get-job-result":{"get":{"operationId":"cloud_aliyun_hcs_mgw_get_job_result","summary":"Obtains the list of files that fail to be migrated when files fail to be migrated during a migration task","description":"GET /job/{jobName}?jobResult","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com","schema":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"}},{"name":"jobName","in":"query","required":true,"description":"The task name","schema":{"type":"string","description":"The task name"}},{"name":"runtimeId","in":"query","required":true,"description":"The execution ID of the task","schema":{"type":"integer","description":"The execution ID of the task"},"example":"1"}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-hcs-mgw/get-report":{"get":{"operationId":"cloud_aliyun_hcs_mgw_get_report","summary":"Obtains the details of a migration report","description":"GET /report","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com","schema":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"}},{"name":"version","in":"query","required":true,"description":"The ID of the migration task","schema":{"type":"string","description":"The ID of the migration task"},"example":"test_job_id"},{"name":"runtimeId","in":"query","required":false,"description":"The execution ID of the migration task","schema":{"type":"integer","description":"The execution ID of the migration task"},"example":"1"}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-hcs-mgw/get-tunnel":{"get":{"operationId":"cloud_aliyun_hcs_mgw_get_tunnel","summary":"Obtains the details of a tunnel","description":"GET /tunnel/{tunnelId}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com","schema":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"}},{"name":"tunnelId","in":"query","required":true,"description":"The tunnel ID","schema":{"type":"string","description":"The tunnel ID"}}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-hcs-mgw/list-address":{"get":{"operationId":"cloud_aliyun_hcs_mgw_list_address","summary":"Lists the data addresses created by a user in the specific region","description":"GET /addresslist","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com","schema":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"}},{"name":"marker","in":"query","required":false,"description":"The marker after which the migration addresses are listed. By default, this parameter is left empty","schema":{"type":"string","description":"The marker after which the migration addresses are listed. By default, this parameter is left empty"},"example":"test_marker"},{"name":"count","in":"query","required":false,"description":"Specifies the number of migration addresses to be returned. Valid values: 0 - 1000 (excluding 0). Default value: 1000","schema":{"type":"integer","description":"Specifies the number of migration addresses to be returned. Valid values: 0 - 1000 (excluding 0). Default value: 1000"},"example":"100"}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-hcs-mgw/list-agent":{"get":{"operationId":"cloud_aliyun_hcs_mgw_list_agent","summary":"Lists the agents created by a user in the specific region","description":"GET /agentlist","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com","schema":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"}},{"name":"marker","in":"query","required":false,"description":"The marker after which the agents are listed.\\ By default, this parameter is left empty","schema":{"type":"string","description":"The marker after which the agents are listed.\\ By default, this parameter is left empty"},"example":"test_agent"},{"name":"count","in":"query","required":false,"description":"Specifies the number of agents to be returned.\\ Valid values: 0 - 1000.\\ Default value: 1000","schema":{"type":"integer","description":"Specifies the number of agents to be returned.\\ Valid values: 0 - 1000.\\ Default value: 1000"},"example":"100"}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-hcs-mgw/list-job":{"get":{"operationId":"cloud_aliyun_hcs_mgw_list_job","summary":"Lists the migration tasks in the region","description":"GET /joblist","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com","schema":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"}},{"name":"marker","in":"query","required":false,"description":"Specifies the marker after which migration tasks are listed. Default value: None","schema":{"type":"string","description":"Specifies the marker after which migration tasks are listed. Default value: None"},"example":"test_marker"},{"name":"count","in":"query","required":false,"description":"Specifies the number of migration tasks to return. Valid values: 1 to 1000. Default value: 1000","schema":{"type":"integer","description":"Specifies the number of migration tasks to return. Valid values: 1 to 1000. Default value: 1000"},"example":"1000"},{"name":"parentName","in":"query","required":false,"description":"The name of the parent task. If you specify this parameter, all subtasks of the parent task are returned","schema":{"type":"string","description":"The name of the parent task. If you specify this parameter, all subtasks of the parent task are returned"},"example":"test_parent_job_name"},{"name":"all","in":"query","required":false,"description":"Specifies whether to return subtasks. Valid values: true, false","schema":{"type":"string","description":"Specifies whether to return subtasks. Valid values: true, false"},"example":"true"}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-hcs-mgw/list-job-history":{"get":{"operationId":"cloud_aliyun_hcs_mgw_list_job_history","summary":"Lists the run history of a migration task","description":"GET /jobhistory/{jobName}","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com","schema":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"}},{"name":"jobName","in":"query","required":true,"description":"The name of the migration task whose run history to retrieve","schema":{"type":"string","description":"The name of the migration task whose run history to retrieve"}},{"name":"runtimeId","in":"query","required":false,"description":"The execution ID of a specific run. Specify this parameter to retrieve the run history for only that execution","schema":{"type":"integer","description":"The execution ID of a specific run. Specify this parameter to retrieve the run history for only that execution"},"example":"1"},{"name":"marker","in":"query","required":false,"description":"The pagination token. Set this parameter to the marker value returned in the previous response to retrieve the next page of results. If…","schema":{"type":"string","description":"The pagination token. Set this parameter to the marker value returned in the previous response to retrieve the next page of results. If…"},"example":"test_marker"},{"name":"count","in":"query","required":false,"description":"The maximum number of history entries to return. Valid values: 1 to 1000. Default value: 1000.","schema":{"type":"integer","description":"The maximum number of history entries to return. Valid values: 1 to 1000. Default value: 1000."},"example":"100"}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-hcs-mgw/list-tunnel":{"get":{"operationId":"cloud_aliyun_hcs_mgw_list_tunnel","summary":"Lists tunnels","description":"GET /tunnellist","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com","schema":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"}},{"name":"marker","in":"query","required":false,"description":"The marker after which tunnels are listed.\\ By default, this parameter is left empty","schema":{"type":"string","description":"The marker after which tunnels are listed.\\ By default, this parameter is left empty"},"example":"test_marker"},{"name":"count","in":"query","required":false,"description":"Specifies the number of tunnels to be returned.\\ Valid values: 0 - 1000.\\ Default value: 1000","schema":{"type":"integer","description":"Specifies the number of tunnels to be returned.\\ Valid values: 0 - 1000.\\ Default value: 1000"},"example":"100"}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-hcs-mgw/update-address":{"post":{"operationId":"cloud_aliyun_hcs_mgw_update_address","summary":"Updates a data address","description":"PUT /address/{addressName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["addressName"],"properties":{"endpoint":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"},"addressName":{"type":"string","description":"The name of the data address"},"ImportAddress":{"type":"string","description":"The details for updating the data address"}}}}}},"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-hcs-mgw/update-job":{"post":{"operationId":"cloud_aliyun_hcs_mgw_update_job","summary":"Updates the status or throttling of a task","description":"PUT /job/{jobName}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jobName"],"properties":{"endpoint":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"},"ImportJob":{"type":"string","description":"The details for updating the task"},"jobName":{"type":"string","description":"The task name"}}}}}},"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-hcs-mgw/update-tunnel":{"post":{"operationId":"cloud_aliyun_hcs_mgw_update_tunnel","summary":"Updates a tunnel","description":"PUT /tunnel/{tunnelId}","tags":["cloud"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tunnelId"],"properties":{"endpoint":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"},"tunnelId":{"type":"string","description":"The tunnel ID"},"ImportTunnel":{"type":"object","description":"The details for updating the tunnel"}}}}}},"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-hcs-mgw/verify-address":{"get":{"operationId":"cloud_aliyun_hcs_mgw_verify_address","summary":"Verifies whether a data address is available","description":"GET /address/{addressName}?verify","tags":["cloud"],"parameters":[{"name":"endpoint","in":"query","required":false,"description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com","schema":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.aliyuncs.com"}},{"name":"addressName","in":"query","required":true,"description":"The name of the data address","schema":{"type":"string","description":"The name of the data address"}}],"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":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/cloud:aliyun-hcs-mgw/version":{"post":{"operationId":"cloud_aliyun_hcs_mgw_version","summary":"version","description":"POST /","tags":["cloud"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endpoint":{"type":"string","enum":["https://ap-northeast-1.mgw.aliyuncs.com","https://ap-southeast-1.mgw.aliyuncs.com","https://cn-beijing.mgw.aliyuncs.com","https://cn-chengdu.mgw.aliyuncs.com","https://cn-hangzhou.mgw.aliyuncs.com","https://cn-hongkong.mgw.aliyuncs.com","https://cn-shanghai.mgw.aliyuncs.com","https://cn-shenzhen.mgw.aliyuncs.com","https://cn-wulanchabu.mgw.aliyuncs.com","https://eu-central-1.mgw.aliyuncs.com","https://us-east-1.mgw.aliyuncs.com","https://us-west-1.mgw.aliyuncs.com"],"default":"https://ap-southeast-1.mgw.aliyuncs.com","description":"Regional endpoint, for example https://ap-southeast-1.mgw.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"}}}}}}}