aliyun-sdk
Version:
Aliyun SDK for JavaScript
1,430 lines (1,420 loc) • 41.8 kB
JSON
{
"format": "rest-json",
"apiVersion": "2015-11-11",
"checksumFormat": "md5",
"endpointPrefix": "batchcompute",
"serviceAbbreviation": "BatchCompute",
"serviceFullName": "Aliyun Batch Computing Service",
"signatureVersion": "batchcompute",
"timestampFormat": "rfc822",
"xmlnamespace": "",
"operations": {
"getAvailable": {
"name": "GetAvailable",
"http": {
"method": "GET",
"uri": "/available"
},
"input": {
},
"output": {
"type": "structure",
"members": {
}
}
},
"getQuotas": {
"name": "GetQuotas",
"http": {
"method": "GET",
"uri": "/quotas"
},
"input": {
},
"output": {
"type": "structure",
"members": {
}
}
},
"createImage": {
"name": "CreateImage",
"http": {
"method": "POST",
"uri": "/images"
},
"input": {
"payload": ["Name", "Platform", "EcsImageId","Description"],
"members": {
"Name":{
"type": "string",
"required": true
},
"EcsImageId": {
"required": true,
"type": "string"
},
"Description": {
"required": false,
"type": "string"
},
"Platform": {
"required": true,
"type": "string"
}
}
},
"output": {
"type": "structure",
"members": {
"JobId": {
"type": "string",
"name": "ResourceId"
}
}
}
},
"listImages": {
"name": "ListImages",
"http": {
"method": "GET",
"uri": "/images?Type={Type}&Marker={Marker}&MaxItemCount={MaxItemCount}"
},
"input": {
"type": "structure",
"members": {
"Type": {
"required": false,
"type": "string",
"location": "uri"
},
"Marker": {
"required": false,
"type":"string",
"location":"uri"
},
"MaxItemCount": {
"required": false,
"type":"integer",
"location":"uri"
}
}
},
"output": {
"type": "structure",
"members": {
}
}
},
"getImage": {
"name": "GetImage",
"http": {
"method": "GET",
"uri": "/images/{ImageId}"
},
"input": {
"type": "structure",
"members": {
"ImageId": {
"required": true,
"type":"string",
"location":"uri"
}
}
},
"output": {
"type": "structure",
"members": {
}
}
},
"deleteImage": {
"name": "DeleteImage",
"http": {
"method": "DELETE",
"uri": "/images/{ImageId}"
},
"input": {
"type": "structure",
"members": {
"ImageId": {
"required": true,
"type":"string",
"location":"uri"
}
}
},
"output": {
"type": "structure",
"members": {
}
}
},
"createCluster": {
"name": "CreateCluster",
"http": {
"method": "POST",
"uri": "/clusters"
},
"input": {
"payload": ["Name", "Description", "ImageId","InstanceType","UserData","Configs", "Groups","Notification"],
"members": {
"Name":{
"type": "string",
"required": true
},
"ImageId": {
"required": true,
"type": "string"
},
"InstanceType": {
"required": false,
"type": "string"
},
"Description": {
"required": false,
"type": "string"
},
"UserData": {
"required": false,
"type": "map",
"members": {
"type": "string"
}
},
"Notification": {
"required": false,
"type": "structure",
"members": {
"Topic": {
"required": false,
"type": "structure",
"members": {
"Name": {
"required": true,
"type": "string"
},
"Endpoint": {
"required": true,
"type": "string"
},
"Events": {
"required": false,
"type": "list"
}
}
}
}
},
"Configs": {
"required": false,
"type": "structure",
"members": {
"Mounts": {
"required": false,
"type": "structure",
"members": {
"Entries": {
"required": false,
"type": "list",
"members": {
"required": false,
"type":"structure",
"members": {
"Destination": {
"required": true,
"type": "string"
},
"Source": {
"required": true,
"type": "string"
},
"WriteSupport": {
"required": true,
"type": "boolean"
}
}
}
},
"Locale": {
"required": false,
"type": "string"
},
"Lock": {
"required": false,
"type": "boolean"
},
"CacheSupport": {
"required": false,
"type": "boolean"
},
"NAS": {
"required": false,
"type": "structure",
"members": {
"AccessGroup": {
"required": false,
"type": "list"
},
"FileSystem": {
"required": false,
"type": "list"
}
}
},
"OSS": {
"required": false,
"type": "structure",
"members": {
"AccessKeyId": {
"required": false,
"type": "string"
},
"AccessKeySecret": {
"required": false,
"type": "string"
},
"AccessSecurityToken": {
"required": false,
"type": "string"
}
}
},
"Networks": {
"required": false,
"type": "structure",
"members": {
"Classic": {
"required": false,
"type": "structure",
"members": {
"AllowIpAddress": {
"required": false,
"type": "list"
},
"AllowIpAddressEgress": {
"required": false,
"type": "list"
},
"AllowSecurityGroup": {
"required": false,
"type": "list"
},
"AllowSecurityGroupEgress": {
"required": false,
"type": "list"
}
}
},
"VPC": {
"required": false,
"type": "structure",
"members": {
"CidrBlock": {
"required": false,
"type": "string"
}
}
}
}
}
}
},
"Disks": {
"required": false,
"type": "structure",
"members": {
"SystemDisk": {
"required": false,
"type": "structure",
"members": {
"Type": {
"required": false,
"type": "string"
},
"Size": {
"required": false,
"type": "integer"
}
}
},
"DataDisk": {
"required": false,
"type": "structure",
"members": {
"Type": {
"required": false,
"type": "string"
},
"Size": {
"required": false,
"type": "integer"
},
"MountPoint": {
"required": false,
"type": "string"
}
}
}
}
}
}
},
"Groups": {
"required":true,
"type": "map",
"members": {
"type": "structure",
"members": {
"DesiredVMCount": {
"required": true,
"type": "integer"
},
"InstanceType": {
"required": false,
"type": "string"
},
"ResourceType": {
"required": false,
"type": "string"
}
}
}
}
}
},
"output": {
"type": "structure",
"members": {
"JobId": {
"type": "string",
"name": "ResourceId"
},
"RequestId": {
"location": "header",
"name": "Request-Id"
}
}
}
},
"listClusters": {
"name": "ListClusters",
"http": {
"method": "GET",
"uri": "/clusters?Marker={Marker}&MaxItemCount={MaxItemCount}"
},
"input": {
"type": "structure",
"members": {
"Marker": {
"required": false,
"type":"string",
"location":"uri"
},
"MaxItemCount": {
"required": false,
"type":"integer",
"location":"uri"
}
}
},
"output": {
"type": "structure",
"members": {
}
}
},
"getCluster": {
"name": "GetCluster",
"http": {
"method": "GET",
"uri": "/clusters/{ClusterId}"
},
"input": {
"type": "structure",
"members": {
"ClusterId": {
"required": true,
"type":"string",
"location":"uri"
}
}
},
"output": {
"type": "structure",
"members": {
}
}
},
"deleteCluster": {
"name": "DeleteCluster",
"http": {
"method": "DELETE",
"uri": "/clusters/{ClusterId}"
},
"input": {
"type": "structure",
"members": {
"ClusterId": {
"required": true,
"type":"string",
"location":"uri"
}
}
},
"output": {
"type": "structure",
"members": {
}
}
},
"changeClusterDesiredVMCount": {
"name": "ChangeClusterDesiredVMCount",
"http": {
"method": "PUT",
"uri": "/clusters/{ClusterId}"
},
"input": {
"payload": ["Groups"],
"members": {
"ClusterId": {
"required": true,
"type":"string",
"location":"uri"
},
"Groups": {
"required":true,
"type": "map",
"members": {
"type": "structure",
"members": {
"DesiredVMCount": {
"required": true,
"type": "integer"
}
}
}
}
}
},
"output": {
"type": "structure",
"members": {
}
}
},
"listClusterInstances": {
"name": "ListClusterInstances",
"http": {
"method": "GET",
"uri": "/clusters/{ClusterId}/groups/{GroupName}/instances?Marker={Marker}&MaxItemCount={MaxItemCount}"
},
"input": {
"type": "structure",
"members": {
"ClusterId": {
"required": true,
"type":"string",
"location":"uri"
},
"GroupName": {
"required": true,
"type":"string",
"location":"uri"
},
"Marker": {
"required": false,
"type":"string",
"location":"uri"
},
"MaxItemCount": {
"required": false,
"type":"integer",
"location":"uri"
}
}
},
"output": {
"type": "structure",
"members": {
}
}
},
"getClusterInstance": {
"name": "GetClusterInstance",
"http": {
"method": "GET",
"uri": "/clusters/{ClusterId}/groups/{GroupName}/instances/{InstanceId}"
},
"input": {
"type": "structure",
"members": {
"ClusterId": {
"required": true,
"type":"string",
"location":"uri"
},
"GroupName": {
"required": true,
"type":"string",
"location":"uri"
},
"InstanceId": {
"required": true,
"type":"string",
"location":"uri"
}
}
},
"output": {
"type": "structure",
"members": {
}
}
},
"deleteClusterInstance": {
"name": "DeleteClusterInstance",
"http": {
"method": "DELETE",
"uri": "/clusters/{ClusterId}/groups/{GroupName}/instances/{InstanceId}"
},
"input": {
"type": "structure",
"members": {
"ClusterId": {
"required": true,
"type":"string",
"location":"uri"
},
"GroupName": {
"required": true,
"type":"string",
"location":"uri"
},
"InstanceId": {
"required": true,
"type":"string",
"location":"uri"
}
}
},
"output": {
"type": "structure",
"members": {
}
}
},
"recreateClusterInstance": {
"name": "RecreateClusterInstance",
"http": {
"method": "POST",
"uri": "/clusters/{ClusterId}/groups/{GroupName}/instances/{InstanceId}/recreate"
},
"input": {
"type": "structure",
"members": {
"ClusterId": {
"required": true,
"type":"string",
"location":"uri"
},
"GroupName": {
"required": true,
"type":"string",
"location":"uri"
},
"InstanceId": {
"required": true,
"type":"string",
"location":"uri"
}
}
},
"output": {
"type": "structure",
"members": {
}
}
},
"listJobs": {
"name": "ListJobs",
"http": {
"method": "GET",
"uri": "/jobs?Marker={Marker}&MaxItemCount={MaxItemCount}&State={State}"
},
"input": {
"type": "structure",
"members": {
"Marker": {
"required": false,
"type": "string",
"location": "uri"
},
"MaxItemCount": {
"required": false,
"type": "integer",
"location": "uri"
},
"State": {
"required": false,
"type": "string",
"location": "uri"
}
}
},
"output": {
"type": "structure",
"members": {
}
}
},
"getJob": {
"name": "GetJob",
"http": {
"method": "GET",
"uri": "/jobs/{JobId}"
},
"input": {
"type": "structure",
"members": {
"JobId": {
"required": true,
"type":"string",
"location":"uri"
}
}
},
"output": {
"type": "structure",
"members": {
}
}
},
"getJobDescription": {
"name": "GetJobDescription",
"http": {
"method": "GET",
"uri": "/jobs/{JobId}?description"
},
"input": {
"type": "structure",
"members": {
"JobId": {
"required": true,
"type":"string",
"location":"uri"
}
}
},
"output": {
"type": "structure",
"members": {
}
}
},
"deleteJob": {
"name": "DeleteJob",
"http": {
"method": "DELETE",
"uri": "/jobs/{JobId}"
},
"input": {
"type": "structure",
"members": {
"JobId": {
"required": true,
"type":"string",
"location":"uri"
}
}
},
"output": {
"type": "structure",
"members": {
}
}
},
"startJob": {
"name": "StartJob",
"http": {
"method": "POST",
"uri": "/jobs/{JobId}/start"
},
"input": {
"type": "structure",
"members": {
"JobId": {
"required": true,
"type":"string",
"location":"uri"
}
}
},
"output": {
"type": "structure",
"members": {
}
}
},
"stopJob": {
"name": "StopJob",
"http": {
"method": "POST",
"uri": "/jobs/{JobId}/stop"
},
"input": {
"type": "structure",
"members": {
"JobId": {
"required": true,
"type":"string",
"location":"uri"
}
}
},
"output": {
"type": "structure",
"members": {
}
}
},
"changeJobPriority": {
"name": "ChangeJobPriority",
"http": {
"method": "PUT",
"uri": "/jobs/{JobId}"
},
"input": {
"payload": ["Priority"],
"members": {
"JobId": {
"required": true,
"type":"string",
"location":"uri"
},
"Priority": {
"required": true,
"type":"integer"
}
}
},
"output": {
"type": "structure",
"members": {
}
}
},
"createJob": {
"name": "CreateJob",
"http": {
"method": "POST",
"uri": "/jobs"
},
"input": {
"payload": ["Name", "Description", "Priority", "JobFailOnInstanceFail","Type","DAG","Notification"],
"members": {
"Name":{
"type": "string",
"required": true
},
"Description": {
"required": false,
"type": "string"
},
"Priority": {
"required": true,
"type": "integer"
},
"Type": {
"required": true,
"type": "string"
},
"JobFailOnInstanceFail": {
"required": true,
"type": "boolean"
},
"AutoRelease": {
"required": false,
"type": "boolean"
},
"Notification": {
"required": false,
"type": "structure",
"members": {
"Topic": {
"required": false,
"type": "structure",
"members": {
"Name": {
"required": true,
"type": "string"
},
"Endpoint": {
"required": true,
"type": "string"
},
"Events": {
"required": false,
"type": "list"
}
}
}
}
},
"DAG": {
"required":true,
"type": "structure",
"members": {
"Tasks": {
"required":true,
"type": "map",
"members": {
"type": "structure",
"members": {
"InstanceCount": {
"required": true,
"type": "integer"
},
"WriteSupport": {
"required": false,
"type": "boolean"
},
"Timeout": {
"required": true,
"type": "integer"
},
"MaxRetryCount": {
"required": false,
"type": "integer"
},
"ClusterId": {
"required": false,
"type": "string"
},
"Mounts": {
"required": false,
"type": "structure",
"members": {
"Entries": {
"required": false,
"type": "list",
"members": {
"required": false,
"type":"structure",
"members": {
"Destination": {
"required": true,
"type": "string"
},
"Source": {
"required": true,
"type": "string"
},
"WriteSupport": {
"required": true,
"type": "boolean"
}
}
}
},
"Locale": {
"required": false,
"type": "string"
},
"Lock": {
"required": false,
"type": "boolean"
},
"CacheSupport": {
"required": false,
"type": "boolean"
},
"NAS": {
"required": false,
"type": "structure",
"members": {
"AccessGroup": {
"required": false,
"type": "list"
},
"FileSystem": {
"required": false,
"type": "list"
}
}
},
"OSS": {
"required": false,
"type": "structure",
"members": {
"AccessKeyId": {
"required": false,
"type": "string"
},
"AccessKeySecret": {
"required": false,
"type": "string"
},
"AccessSecurityToken": {
"required": false,
"type": "string"
}
}
},
"Networks": {
"required": false,
"type": "structure",
"members": {
"Classic": {
"required": false,
"type": "structure",
"members": {
"AllowIpAddress": {
"required": false,
"type": "list"
},
"AllowIpAddressEgress": {
"required": false,
"type": "list"
},
"AllowSecurityGroup": {
"required": false,
"type": "list"
},
"AllowSecurityGroupEgress": {
"required": false,
"type": "list"
}
}
},
"VPC": {
"required": false,
"type": "structure",
"members": {
"CidrBlock": {
"required": false,
"type": "string"
}
}
}
}
}
}
},
"AutoCluster": {
"required": false,
"type": "structure",
"members": {
"ReserveOnFail": {
"required": false,
"type": "boolean"
},
"ImageId": {
"required": false,
"type": "string"
},
"ECSImageId": {
"required": false,
"type": "string"
},
"InstanceType": {
"required": true,
"type": "string"
},
"ResourceType": {
"required": false,
"type": "string"
},
"UserData": {
"required": false,
"type": "map",
"members": {
"type": "string"
}
},
"Configs": {
"required": false,
"type": "structure",
"members": {
"Mounts": {
"required": false,
"type": "structure",
"members": {
"Entries": {
"required": false,
"type": "list",
"members": {
"required": false,
"type":"structure",
"members": {
"Destination": {
"required": true,
"type": "string"
},
"Source": {
"required": true,
"type": "string"
},
"WriteSupport": {
"required": true,
"type": "boolean"
}
}
}
},
"Locale": {
"required": false,
"type": "string"
},
"Lock": {
"required": false,
"type": "boolean"
},
"CacheSupport": {
"required": false,
"type": "boolean"
},
"NAS": {
"required": false,
"type": "structure",
"members": {
"AccessGroup": {
"required": false,
"type": "list"
},
"FileSystem": {
"required": false,
"type": "list"
}
}
},
"OSS": {
"required": false,
"type": "structure",
"members": {
"AccessKeyId": {
"required": false,
"type": "string"
},
"AccessKeySecret": {
"required": false,
"type": "string"
},
"AccessSecurityToken": {
"required": false,
"type": "string"
}
}
},
"Networks": {
"required": false,
"type": "structure",
"members": {
"Classic": {
"required": false,
"type": "structure",
"members": {
"AllowIpAddress": {
"required": false,
"type": "list"
},
"AllowIpAddressEgress": {
"required": false,
"type": "list"
},
"AllowSecurityGroup": {
"required": false,
"type": "list"
},
"AllowSecurityGroupEgress": {
"required": false,
"type": "list"
}
}
},
"VPC": {
"required": false,
"type": "structure",
"members": {
"CidrBlock": {
"required": false,
"type": "string"
}
}
}
}
}
}
},
"Disks": {
"required": false,
"type": "structure",
"members": {
"SystemDisk": {
"required": false,
"type": "structure",
"members": {
"Type": {
"required": false,
"type": "string"
},
"Size": {
"required": false,
"type": "integer"
}
}
},
"DataDisk": {
"required": false,
"type": "structure",
"members": {
"Type": {
"required": false,
"type": "string"
},
"Size": {
"required": false,
"type": "integer"
},
"MountPoint": {
"required": false,
"type": "string"
}
}
}
}
}
}
}
}
},
"InputMapping": {
"required": false,
"type": "map",
"members":{
"type":"string"
}
},
"OutputMapping": {
"required": false,
"type": "map",
"members":{
"type":"string"
}
},
"LogMapping": {
"required": false,
"type": "map",
"members":{
"type":"string"
}
},
"Parameters": {
"type": "structure",
"required": true,
"members": {
"StderrRedirectPath": {
"type": "string",
"required": true
},
"StdoutRedirectPath": {
"type": "string",
"required": true
},
"InputMappingConfig": {
"type": "structure",
"required": false,
"members": {
"Locale": {
"type": "string",
"required": false
},
"Lock": {
"type": "boolean",
"required": false
}
}
},
"Command": {
"type": "structure",
"required": true,
"members": {
"CommandLine": {
"type": "string",
"required": true
},
"PackagePath": {
"type": "string",
"required": true
},
"EnvVars": {
"required": false,
"type": "map",
"members":{
"type":"string"
}
}
}
}
}
}
}
}
},
"Dependencies": {
"type": "map",
"required": false,
"members": {
"type": "list"
}
}
}
}
}
},
"output": {
"type": "structure",
"members": {
"JobId": {
"type": "string",
"name": "ResourceId"
},
"RequestId": {
"location": "header",
"name": "Request-Id"
}
}
}
},
"listTasks": {
"name": "ListTasks",
"http": {
"method": "GET",
"uri": "/jobs/{JobId}/tasks?Marker={Marker}&MaxItemCount={MaxItemCount}"
},
"input": {
"type": "structure",
"members": {
"JobId": {
"required": true,
"type":"string",
"location":"uri"
},
"Marker": {
"required": false,
"type": "string",
"location": "uri"
},
"MaxItemCount": {
"required": false,
"type": "integer",
"location": "uri"
}
}
},
"output": {
"type": "structure",
"members": {
}
}
},
"getTask": {
"name": "GetTask",
"http": {
"method": "GET",
"uri": "/jobs/{JobId}/tasks/{TaskName}"
},
"input": {
"type": "structure",
"members": {
"JobId": {
"required": true,
"type":"string",
"location":"uri"
},
"TaskName": {
"required": true,
"type": "string",
"location": "uri"
}
}
},
"output": {
"type": "structure",
"members": {
}
}
},
"listInstances": {
"name": "ListInstances",
"http": {
"method": "GET",
"uri": "/jobs/{JobId}/tasks/{TaskName}/instances?Marker={Marker}&MaxItemCount={MaxItemCount}"
},
"input": {
"type": "structure",
"members": {
"JobId": {
"required": true,
"type":"string",
"location":"uri"
},
"TaskName": {
"required": true,
"type":"string",
"location":"uri"
},
"Marker": {
"required": false,
"type": "string",
"location": "uri"
},
"MaxItemCount": {
"required": false,
"type": "integer",
"location": "uri"
}
}
},
"output": {
"type": "structure",
"members": {
}
}
},
"getInstance": {
"name": "GetInstance",
"http": {
"method": "GET",
"uri": "/jobs/{JobId}/tasks/{TaskName}/instances/{InstanceId}"
},
"input": {
"type": "structure",
"members": {
"JobId": {
"required": true,
"type":"string",
"location":"uri"
},
"TaskName": {
"required": true,
"type": "string",
"location": "uri"
},
"InstanceId": {
"required": true,
"type":"string",
"location":"uri"
}
}
},
"output": {
"type": "structure",
"members": {
}
}
}
},
"pagination": {
}
}