查询短信应用 - ListAppDetails
功能介绍
该接口用于用户查询已创建的应用信息。
URI
GET /v2/{project_id}/msgsms/apps
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 项目ID,参考“获取账号、用户、项目的名称和ID” |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| app_name | 否 | String | 应用名称 |
| end_time | 否 | String | 结束时间 |
| limit | 否 | Integer | 数量,默认值10 |
| offset | 否 | Integer | 偏移量 |
| region | 否 | String | 地域
|
| sort_dir | 否 | String | 排序方式
|
| sort_key | 否 | String | 排序字段,仅支持create_time |
| start_time | 否 | String | 开始时间 |
| status | 否 | String | 状态 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Content-Type | 是 | String | 请求体参数类型,该字段必须设置为:application/json |
| X-Auth-Token | 是 | String | 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值) |
响应参数
状态码: 200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| results | Array of SmsAppQueryResp | 查询结果 |
| total | Long | 总数 |
| 参数 | 描述 |
|---|---|
| id | 应用主键ID,用于获取、修改应用的唯一标识 |
| create_time | 创建时间 |
| update_time | 更新时间 |
| customer_id | 租户customer id |
| resource_id | 租户resource id |
| developer_account | 租户开发者账号 |
| app_name | 应用名称 |
| app_key | 应用key |
| status | 应用状态
|
| region | 地域 |
| intl_channel_num | 全球短信通道号 |
| enterprise_project_id | 企业项目ID |
| enterprise_project_name | 企业项目名称 |
| app_access_addr | 接入地址 |
| protocol | 协议 |
| platform | 平台 |
请求示例
GET /v2/845ada5bc7444f1295cd517af0123da1/msgsms/apps?app_name=auto_test789 Host: 100.85.***.***:30300 Content-Type: application/json X-Auth-Token:******
响应示例
{
"results": [
{
"id": "9e61f59c-1a6b-4ee5-9651-5bca450694b3",
"create_time": "2022-08-12 06:51:17",
"update_time": "2022-08-12 06:51:17",
"customer_id": "******c55c3c4526b2ed7a0213bc9871",
"tenant": {
"customer_id": "******c55c3c4526b2ed7a0213bc9871",
"customer_name": "****05",
"enterprise_name": "华为技术有限公司"
},
"resource_id": "******8a-a690-4e14-a1c7-2430937336d0",
"developer_account": "****66_sms",
"app_name": "auto_test789",
"omp_app_name": "******4877bf46b5906a3240636bc7aa",
"app_key": "******3baZf4c856O4Qrbqvui3K2",
"status": "LAUNCHED",
"industry": 14,
"region": "cn",
"intl_channel_num": "******886739",
"enterprise_project_id": "0",
"enterprise_project_name": "default",
"app_access_addr": "https://100.**.***.**:443",
"protocol": "HTTP",
"platform": "NFV",
"is_support_multiomp": false
}
],
"total": 1
} 返回值
| 返回值 | 描述 |
|---|---|
| 200 | OK |
| 401 | Unauthorized |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | System error |