{ "name": "hai", "display_name": "高性能应用服务", "description": "介绍如何使用API对高性能应用服务进行相关操作，包括创建、销毁、硬盘扩容等", "domain": "compute", "api_version": "2023-08-12", "endpoint": "hai.tencentcloudapi.com", "actions": [ { "name": "CreateApplication", "description": "本接口（CreateApplication）用于对HAI实例制作自定义应用。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "需要制作自定义应用的HAI实例ID", "example": "hai-0asd1" }, { "name": "ApplicationName", "type": "string", "required": true, "description": "自定义应用的应用名称", "example": " 我的HAI应用" }, { "name": "ApplicationDescription", "type": "string", "required": false, "description": "自定义应用的描述", "example": "这是我的pytorch HAI自定义应用" } ], "required": [ "InstanceId", "ApplicationName" ] }, { "name": "CreateMuskPrompt", "description": "创建musk prompt 任务", "status": "online", "parameters": [ { "name": "WorkgroupId", "type": "string", "required": true, "description": "workgroup id", "example": "4a3f3be9-f35b-40bf-b6bb-2af812dd63cb" }, { "name": "WorkflowId", "type": "string", "required": true, "description": "workflow id", "example": "wf-b9dbb48a-f4cd-40f3-9a68-2af4c78d31a7" }, { "name": "PromptParams", "type": "string", "required": true, "description": "prompt 参数", "example": "{\"6\":{\"inputs\":{\"text\":\"cute anime girl with massive fluffy fennec ears and a big fluffy tail blonde messy long hair blue eyes wearing a maid outfit with a long black gold leaf pattern dress and a white apron mouth open holding a fancy black forest cake with candles on top in the kitchen of an old dark Victorian mansion lit by candlelight with a bright window to the foggy forest and very expensive stuff everywhere\",\"clip\":[\"11\",0]},\"class_type\":\"CLIPTextEncode\",\"_meta\":{\"title\":\"CLIP Text Encode (Positive Prompt)\"}},\"8\":{\"inputs\":{\"samples\":[\"13\",0],\"vae\":[\"10\",0]},\"class_type\":\"VAEDecode\",\"_meta\":{\"title\":\"VAE解码\"}},\"9\":{\"inputs\":{\"filename_prefix\":\"ComfyUI\",\"images\":[\"8\",0]},\"class_type\":\"SaveImage\",\"_meta\":{\"title\":\"保存图像\"}},\"10\":{\"inputs\":{\"vae_name\":\"ae.sft\"},\"class_type\":\"VAELoader\",\"_meta\":{\"title\":\"加载VAE\"}},\"11\":{\"inputs\":{\"clip_name1\":\"t5xxl_fp8_e4m3fn.safetensors\",\"clip_name2\":\"clip_l.safetensors\",\"type\":\"flux\"},\"class_type\":\"DualCLIPLoader\",\"_meta\":{\"title\":\"双CLIP加载器\"}},\"12\":{\"inputs\":{\"unet_name\":\"flux1-dev-fp8.safetensors\",\"weight_dtype\":\"fp8_e4m3fn\"},\"class_type\":\"UNETLoader\",\"_meta\":{\"title\":\"加载扩散模型\"}},\"13\":{\"inputs\":{\"noise\":[\"25\",0],\"guider\":[\"22\",0],\"sampler\":[\"16\",0],\"sigmas\":[\"17\",0],\"latent_image\":[\"27\",0]},\"class_type\":\"SamplerCustomAdvanced\",\"_meta\":{\"title\":\"自定义采样器（高级）\"}},\"16\":{\"inputs\":{\"sampler_name\":\"euler\"},\"class_type\":\"KSamplerSelect\",\"_meta\":{\"title\":\"K采样器选择\"}},\"17\":{\"inputs\":{\"scheduler\":\"simple\",\"steps\":20,\"denoise\":1,\"model\":[\"30\",0]},\"class_type\":\"BasicScheduler\",\"_meta\":{\"title\":\"基本调度器\"}},\"22\":{\"inputs\":{\"model\":[\"30\",0],\"conditioning\":[\"26\",0]},\"class_type\":\"BasicGuider\",\"_meta\":{\"title\":\"基本引导器\"}},\"25\":{\"inputs\":{\"noise_seed\":317016131367339},\"class_type\":\"RandomNoise\",\"_meta\":{\"title\":\"随机噪声\"}},\"26\":{\"inputs\":{\"guidance\":3.5,\"conditioning\":[\"6\",0]},\"class_type\":\"FluxGuidance\",\"_meta\":{\"title\":\"Flux引导\"}},\"27\":{\"inputs\":{\"width\":1024,\"height\":1024,\"batch_size\":1},\"class_type\":\"EmptySD3LatentImage\",\"_meta\":{\"title\":\"空SD3潜空间图像\"}},\"30\":{\"inputs\":{\"max_shift\":1.15,\"base_shift\":0.5,\"width\":1024,\"height\":1024,\"model\":[\"12\",0]},\"class_type\":\"ModelSamplingFlux\",\"_meta\":{\"title\":\"模型采样Flux\"}}}" } ], "required": [ "WorkgroupId", "WorkflowId", "PromptParams" ] }, { "name": "DescribeApplications", "description": "本接口（DescribeApplications）用于查询应用", "status": "online", "parameters": [ { "name": "ApplicationIds", "type": "array", "required": false, "description": "应用id列表。单次请求数量上限为100个。", "example": "[\"app-q69qsc9v\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤器，跟ApplicationIds不能共用，支持的filter主要有：application-id: 精确匹配;scene-id: 精确匹配，通过调用接口 [DescribeScenes](https://cloud.tencent.com/document/api/1721/101608)获取;application-name: 模糊匹配;application-type: 精确匹配，枚举类型如下：PUBLIC_APPLICATION（公共应用）/ PRIVATE_APPLICATION（自定义应用）/ COMMUNITY_APPLICATION（社区应用）;", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "instance-id" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"hai-12345678\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，不得小于0，默认为0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回量，不得大于100，默认为20", "example": "20" }, { "name": "OrderField", "type": "string", "required": false, "description": "应用列表排序的依据字段。取值范围：\"CREATED_TIME\"：依据应用的创建时间排序。 \"APPLICATION_SIZE\"：依据应用的大小排序。默认按应用的创建时间排序。", "example": "CREATE_TIME" }, { "name": "Order", "type": "string", "required": false, "description": "输出应用列表的排列顺序。取值范围：\"ASC\"：升序排列。 \"DESC\"：降序排列。默认按降序排列。", "example": "ASC" } ], "required": [] }, { "name": "DescribeInstanceNetworkStatus", "description": "本接口（DescribeInstanceNetworkStatus）用于查询实例的网络配置及消耗情况", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例ID数组，单次请求最多不超过100个实例；实例ID通过调用接口[DescribeInstances](https://cloud.tencent.com/document/api/1721/101612)获取。", "example": "[\"hai-12345678\"]", "item_type": "string" } ], "required": [ "InstanceIds" ] }, { "name": "DescribeInstances", "description": "本接口（DescribeInstances）用户查询实例", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": false, "description": "实例元组，数量上限100", "example": "[\"hai-12345678\"]", "item_type": "string" }, { "name": "Filters", "type": "array", "required": false, "description": "描述键值对过滤器，用于条件过滤查询。目前支持的过滤器有： instance-id，实例id； instance-state，实例状态：RUNNING，PENDING，STOPPED，ARREARS，STOPPED_NO_CHARGE； charge-type，付费方式：PREPAID_BY_MONTH，POSTPAID_BY_HOUR； public-ip-address，公网IP过滤", "example": "无", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "instance-id" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"hai-12345678\"]", "item_type": "string" } ] }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认为0，不得大于100", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "返回量，默认为20，不能小于0", "example": "20" } ], "required": [] }, { "name": "DescribeMuskPrompts", "description": "获取prompt任务列表", "status": "online", "parameters": [ { "name": "WorkgroupId", "type": "string", "required": true, "description": "workgroup id", "example": "4a3f3be9-f35b-40bf-b6bb-2af812dd63cb" }, { "name": "WorkflowId", "type": "string", "required": true, "description": "workflow id", "example": "wf-b9dbb48a-f4cd-40f3-9a68-2af4c78d31a7" }, { "name": "Offset", "type": "integer", "required": true, "description": "offset", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "limit", "example": "20" }, { "name": "Filters", "type": "array", "required": false, "description": "过滤参数 支持过滤的键值： PromptId，Status", "example": "[{\"Name\":\"PromptId\", Values:[\"dhfhds-dhdhd-xxdfdf-iejmrhf\"]}]", "item_type": "object", "children": [ { "name": "Name", "type": "string", "required": true, "description": "需要过滤的字段。", "example": "instance-id" }, { "name": "Values", "type": "array", "required": true, "description": "字段的过滤值。", "example": "[\"hai-12345678\"]", "item_type": "string" } ] } ], "required": [ "WorkgroupId", "WorkflowId", "Offset", "Limit" ] }, { "name": "DescribeRegions", "description": "本接口（DescribeRegions）用于查询地域列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeScenes", "description": "本接口（DescribeScenes）用于查询场景", "status": "online", "parameters": [ { "name": "SceneIds", "type": "array", "required": false, "description": "场景id列表，单次能查询100个场景id", "example": "[\"sc-7ramp21e\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeServiceLoginSettings", "description": "本接口（DescribeServiceLoginSettings）用于查询服务登录配置", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID通过调用接口[DescribeInstances](https://cloud.tencent.com/document/api/1721/101612)获取。", "example": "hai-12345678" }, { "name": "ServiceName", "type": "string", "required": false, "description": "服务名称", "example": "jupyter" } ], "required": [ "InstanceId" ] }, { "name": "DescribeServices", "description": "本接口 (DescribeServices) 用于查询一个或多个服务", "status": "online", "parameters": [ { "name": "ServiceIds", "type": "array", "required": false, "description": "服务列表", "example": "[\"svc-dde3hd4i\"]", "item_type": "string" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量", "example": "0" } ], "required": [] }, { "name": "InquirePriceRunInstances", "description": "本接口 (InquirePriceRunInstances) 用于实例询价。", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "应用ID通过调用接口[DescribeApplications](https://cloud.tencent.com/document/api/1721/101609)获取。", "example": "app-jknfna" }, { "name": "BundleType", "type": "string", "required": true, "description": "算力套餐类型, 枚举：XL,XL_2X, 3XL, 3XL_2X, 4XL, 24GB_A.", "example": "XL" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "实例系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。", "example": "{\"DiskType\":\"CLOUD_PREMIUM\",\"DiskSize\":250}", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "系统盘类型。取值范围：CLOUD_PREMIUM：高性能云硬盘CLOUD_HSSD：增强型SSD云盘默认取值：当前有库存的硬盘类型。", "example": "CLOUD_PREMIUM" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位：GB。默认值为 80，取值范围：80-1000", "example": "250" }, { "name": "DiskName", "type": "string", "required": false, "description": "系统盘分区盘符", "example": "vda2" } ] }, { "name": "InstanceCount", "type": "integer", "required": false, "description": "购买实例数量，单次请求实例数量上限为10。", "example": "1" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例显示名称，名称长度限制为128个字符。", "example": "hai" }, { "name": "ClientToken", "type": "string", "required": false, "description": "幂等请求token", "example": "hai-0-109261e6-c992-4d68-8b91-a70fac0da7b4" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "DryRun为True就是只验接口连通性，默认为False", "example": "False" }, { "name": "InstanceChargeType", "type": "string", "required": false, "description": "付费方式，POSTPAID_BY_HOUR按量后付费，PREPAID_BY_MONTH预付费按月，PREPAID_BY_DAY预付费按天", "example": "PREPAID_BY_MONTH" }, { "name": "InstanceChargePrepaid", "type": "object", "required": false, "description": "预付费参数", "example": "{'Period':2,'RenewFlag':'NOTIFY_AND_MANUAL_RENEW'，‘TimeUnit’: 'DAY'}", "children": [ { "name": "Period", "type": "integer", "required": false, "description": "时长，默认值：1", "example": "1" }, { "name": "RenewFlag", "type": "string", "required": false, "description": "续费标志可选参数： NOTIFY_AND_MANUAL_RENEW：表示默认状态(用户未设置，即初始状态：若用户有预付费不停服特权，也会对该值进行自动续费) NOTIFY_AND_AUTO_RENEW：表示自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：表示明确不自动续费(用户设置) 默认值：NOTIFY_AND_MANUAL_RENEW", "example": "NOTIFY_AND_MANUAL_RENEW" }, { "name": "TimeUnit", "type": "string", "required": false, "description": "时长单位，枚举： MONTH, DAY, HOUR；释义：月，日，小时", "example": "MONTH" } ] } ], "required": [ "ApplicationId", "BundleType" ] }, { "name": "InquirePriceUpdateServiceConfigs", "description": "本接口(InquirePriceUpdateServiceConfigs)用于更新服务配置询价", "status": "online", "parameters": [], "required": [] }, { "name": "ResetInstancesPassword", "description": "本接口 (ResetInstancesPassword) 用于重置实例的用户密码。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例ID列表", "example": "['hai-2dfajzo4q']\t", "item_type": "string" }, { "name": "Password", "type": "string", "required": true, "description": "实例密码必须8-30位，推荐使用12位以上密码，不能以“/”开头，至少包含以下字符中的三种不同字符，字符种类：小写字母：[a-z]大写字母：[A-Z]数字：0-9特殊字符： ()\\`\\~!@#$%^\u0026\\*-+=\\_|{}[]:;',.?/", "example": "test@11111." }, { "name": "DryRun", "type": "boolean", "required": false, "description": "默认为False，True代表只验证接口连通性", "example": "False" } ], "required": [ "InstanceIds", "Password" ] }, { "name": "ResizeInstanceDisk", "description": "本接口（ResizeInstanceDisk）用于对指定HAI实例进行扩容云硬盘操作。", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "需要扩容云盘的HAI实例ID", "example": "hai-0asd1" }, { "name": "DiskSize", "type": "integer", "required": true, "description": "扩容云硬盘大小，单位为GB，必须大于当前云硬盘大小。", "example": "180" } ], "required": [ "InstanceId", "DiskSize" ] }, { "name": "RunInstances", "description": "本接口 (RunInstances) 用于创建一个或多个指定配置的实例。", "status": "online", "parameters": [ { "name": "ApplicationId", "type": "string", "required": true, "description": "应用ID通过调用接口[DescribeApplications](https://cloud.tencent.com/document/api/1721/101609)获取。", "example": "app-jknfna" }, { "name": "BundleType", "type": "string", "required": true, "description": "算力套餐类型, 枚举：XL,XL_2X, 3XL, 3XL_2X, 4XL, 24GB_A", "example": "XL" }, { "name": "SystemDisk", "type": "object", "required": false, "description": "实例系统盘配置信息。若不指定该参数，则按照系统默认值进行分配。", "example": "{\"DiskType\":\"CLOUD_PREMIUM\",\"DiskSize\":250}", "children": [ { "name": "DiskType", "type": "string", "required": false, "description": "系统盘类型。取值范围：CLOUD_PREMIUM：高性能云硬盘CLOUD_HSSD：增强型SSD云盘默认取值：当前有库存的硬盘类型。", "example": "CLOUD_PREMIUM" }, { "name": "DiskSize", "type": "integer", "required": false, "description": "系统盘大小，单位：GB。默认值为 80，取值范围：80-1000", "example": "250" }, { "name": "DiskName", "type": "string", "required": false, "description": "系统盘分区盘符", "example": "vda2" } ] }, { "name": "InstanceCount", "type": "integer", "required": false, "description": "购买实例数量，单次请求实例数量上限为10.", "example": "1" }, { "name": "InstanceName", "type": "string", "required": false, "description": "实例显示名称，名称长度限制为128个字符.", "example": "hai" }, { "name": "ClientToken", "type": "string", "required": false, "description": "幂等请求的token", "example": "hai-0-109261e6-c992-4d68-8b91-a70fac0da7b4" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "DryRun为True就是只验接口连通性，默认为False", "example": "False" } ], "required": [ "ApplicationId", "BundleType" ] }, { "name": "StartInstance", "description": "本接口 (StartInstance) 用于主动启动实例。 ‘运行中’、‘预付费’的实例不支持启动实例", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1721/101612) API获取实例ID。", "example": "hai-2dfajzo4q" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "默认为False，True代表只验证接口连通性", "example": "False" } ], "required": [ "InstanceId" ] }, { "name": "StopInstance", "description": "本接口 (StopInstance) 用于主动关闭实例。 ‘已关机’、‘预付费’的实例不支持关机", "status": "online", "parameters": [ { "name": "InstanceId", "type": "string", "required": true, "description": "实例ID。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1721/101612) API获取实例ID。", "example": "hai-2dfajzo4q" }, { "name": "StopMode", "type": "string", "required": false, "description": "hai实例关机的模式，目前仅支持关机不收费： STOP_CHARGE -- 关闭hai实例，释放计算资源，停止收取计算资源的费用。 注意：默认值为STOP_CHARGE", "example": "STOP_CHARGE" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "默认为False，True代表只验证接口连通性", "example": "False" } ], "required": [ "InstanceId" ] }, { "name": "TerminateInstances", "description": "本接口 (TerminateInstances) 用于主动退还实例。", "status": "online", "parameters": [ { "name": "InstanceIds", "type": "array", "required": true, "description": "实例ID列表。可通过[DescribeInstances](https://cloud.tencent.com/document/api/1721/101612) API获取实例ID列表。单次能查询100个InstanceId。", "example": "['hai-2dfajzo4q']\t", "item_type": "string" }, { "name": "DryRun", "type": "boolean", "required": false, "description": "默认为False，True代表只验证接口连通性", "example": "False" } ], "required": [ "InstanceIds" ] }, { "name": "UpdateServiceConfigs", "description": "本接口(UpdateServiceConfigs)用于更新服务配置", "status": "online", "parameters": [ { "name": "ServiceId", "type": "string", "required": true, "description": "服务ID", "example": "svc-3m6xrkjj" }, { "name": "TargetReplicas", "type": "integer", "required": false, "description": "期望副本数", "example": "2" } ], "required": [ "ServiceId" ] } ] }