获取应用列表。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com?Action=GetAppList&Version=2022-10-12
ServiceName: apmplus_openapi
Region: cn-beijing
X-App-Ids: xxx
Content-Type: application/json
请求参数
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | GetAppList | 接口名称。当前 API 的名称为 GetAppList。 |
| Version | String | 是 | 2022-10-12 | 接口版本。当前 API 的版本为 2022-10-12。 |
Body
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| aids | Array of Long | 否 | [] | 不传的时候查询用户所有App。 |
| app_name | String | 否 | app_test | 模糊查询app_name，可以不传。 |
| page_no | Integer | 是 | 1 | 页号。 |
| page_size | Integer | 是 | 10 | 每页项数。 |
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| data | Object of ListAppData | - | 应用列表。 |
| error_msg | String | "" | 错误信息，成功为空。 |
| error_no | Integer | 0 | 错误码，成功为0。 |
ListAppData
| 参数 | 类型 | 示例值 | 描述 |
|---|
| total | Integer | 10 | 总应用数。 |
| result | Array of App | - | 应用列表。 |
| permission_service_keys | Array of String | [app_monitor] | 应用已开通的服务。 |
App
| 参数 | 类型 | 示例值 | 描述 |
|---|
| aid | Long | 123456 | 应用ID。 |
| app_name | String | test_应用性能全链路监控 | 应用中文名。 |
| app_en_name | String | test_apmplus | 应用英文名。 |
| icon_url | String | - | icon url。 |
| app_token | String | - | 默认返回最先创建的token，没有则为空。 |
| create_time | Integer | 1666077679 | 应用创建时间。 |
| accessable_services_map | JSON Map | - | 该应用已开通的产品，按service_key分组，多开需求之后的数据。 |
AccessableServicesMap
| 参数 | 类型 | 示例值 | 描述 |
|---|
| key | String | app_monitor | 该应用已开通的产品。 |
| value | Array of ServiceInstance | test | 产品对应的value。 |
ServiceInstance
| 参数 | 类型 | 示例值 | 描述 |
|---|
| service_key | String | app_monitor | 服务类型。 |
| aid | Long | 123456 | 应用ID。 |
instance_status | String | expired
| 服务实例状态。 - normal：正常
- overrange：超量
- expired：超期
- closed：关闭
|
| pay_order_num | String | 3252617******* | 支付订单号。 |
| preorder_nums | String | 1234567******* | 配置单号。 |
| create_time | Long | 1666077679 | 服务创建时间。 |
| expire_time | Long | 1666077679 | 服务到期时间。 |
| created_by | String | test_user | 服务创建人。 |
| amount | Long | 123 | 已用事件量。 |
| total | Long | 12345 | 总购买事件量。 |
请求示例
POST https://open.volcengineapi.com?Action=GetAppList&Version=2022-10-12
{
"page_no": 1,
"page_size": 10,
"aids": [],
"app_name": "app_test"
}
返回示例
{
"error_no": 0,
"error_msg": "",
"data": {
"result": [
{
"icon_url": "",
"id": 1122334,
"app_type": "",
"app_key": "",
"aid": 123456,
"app_name": "test_应用性能全链路监控",
"app_en_name": "test_apmplus",
"create_time": 1666077679
}
],
"total": 10,
"permission_service_keys": "[app_monitor]"
}
}
错误码
本接口无特有的错误码。更多信息请参见错误码。