了解Open API Swagger信息：GetOpenAPIv2_OpenAPIv2_云容器实例API
API简介
GetOpenAPIv2_OpenAPIv2_云容器实例API是云容器服务（Cloud Container Service）提供的一个API接口，用于获取云容器实例的相关信息，该API遵循Open API规范,通过Swagger接口文档可以方便地查看和使用。
API路径
该API的路径为 /api/v2/openapi，具体请求方式为 GET。
参数说明
以下为该API接口的参数说明：
| 参数名 | 参数类型 | 是否必填 | 描述 |
|---|---|---|---|
| access_token | String | 是 | 用户访问API的认证令牌 |
| project_id | String | 是 | 项目ID，用于标识用户所属的项目 |
| instance_id | String | 否 | 容器实例ID，用于指定要查询的容器实例，不填则查询所有实例 |
| name | String | 否 | 容器实例名称，用于模糊查询容器实例，不填则查询所有实例 |
| status | String | 否 | 容器实例状态，可选值：running、stopped、terminated，用于筛选特定状态的实例 |
响应示例
以下为该API接口的响应示例：
{
"code": 200,
"message": "查询成功",
"data": {
"total": 10,
"instances": [
{
"id": "1234567890abcdef12345678",
"name": "my-instance",
"status": "running",
"image": "my-image",
"cpu": 2,
"memory": 4,
"created_at": "2025-01-01T00:00:00Z"
},
{
"id": "abcdef1234567890abcdef12",
"name": "another-instance",
"status": "stopped",
"image": "another-image",
"cpu": 1,
"memory": 2,
"created_at": "2025-01-02T00:00:00Z"
}
]
}
}
使用注意事项
- 在使用该API接口时，请确保已经获取到有效的
access_token和project_id。 - 根据实际需求，可以选择性地传入
instance_id、name和status参数进行查询。 - 当查询结果为空时,表示没有找到符合条件的容器实例。
FAQs
Q1：如何获取access_token？
A1：您可以通过访问云容器服务的认证接口，使用您的用户名和密码进行认证，获取到access_token。
Q2：如何查询特定状态的容器实例？
A2：在调用API时，可以在请求参数中传入status参数，并指定您想要查询的状态，例如status=running，这样,API将只返回处于运行状态的容器实例。
图片来源于AI模型，如侵权请联系管理员。作者：酷小编，如若转载，请注明出处：https://www.kufanyun.com/ask/97602.html
