Web应用托管服务应用API有哪些? -问答-阿里云开发者社区-阿里云

开发者社区> 问答> 正文

Web应用托管服务应用API有哪些?

小天使爱美 2020-03-23 14:45:12 152

Web应用托管服务应用API有哪些?

API
分享到
取消 提交回答
全部回答(1)
  • 小天使爱美
    2020-03-23 14:54:22

    调用DescribeApplications查询应用信息。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求头 该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

    请求语法 GET /pop/v1/wam/application HTTPS|HTTP 请求参数 名称 类型 是否必选 示例值 描述 AppId String 否 wa-5d1af9c802470221ab7***** 应用ID,查询特定应用信息

    PageSize Integer 否 10 查询页面大小

    PageNumber Integer 否 1 查询页面数

    AppName String 否 appTest 应用名称,查询此名称的应用

    AppSearch String 否 appSearch 查询的应用名关键字,若应用名称包含此关键字,则返回此应用的关键字

    EnvSearch String 否 testEnv 搜索应用中环境名的关键字,若应用中的环境名包含此关键字,则返回此应用

    StackSearch String 否 Java 栈类型搜索

    CategorySearch String 否 Java 技术栈分类

    返回数据 名称 类型 示例值 描述 Applications Array 应用列表

    Code String OK 响应代码,若成功请求为OK

    Message String success 响应消息,若成功请求为success

    PageNumber Integer 1 查询页面数量

    PageSize Integer 20 查询页面大小

    RequestId String 132BF104-A660-40C7-936B-F805967***** 请求ID

    TotalCount Integer 1 查询结果总数

    示例 请求示例

    http://webplus.cn-hangzhou.aliyuncs.com/pop/v1/wam/application?PageSize=20&EnvSearch=test?<公共请求参数> 正常返回示例

    XML 格式

    1 1 success 20 761C51B0-9026-4659-989C-7AFDFEE***** Java user1 user1 1562048968834 wa-5d1af9c802470221ab7***** 2 1562048968834 test 0 2 OK JSON 格式

    { "TotalCount": 1, "Message": "success", "PageSize": 20, "RequestId": "00C3CEDB-9E1B-4872-985E-BB2B7D6*****", "Applications": { "Application": [ { "UpdateUsername": "user1", "AppDescription": "", "TerminatedEnvs": 0, "AppId": "wa-5d1af9c802470221ab7*****", "CreateTime": 1562048968834, "TotalEnvs": 2, "UpdateTime": 1562048968834, "CategoryName": "Java", "CreateUsername": "user1", "AppName": "test", "RunningEnvs": 2 } ] }, "PageNumber": 1, "Code": "OK" } 错误码 访问错误中心查看更多错误码。

    使用CreateApplication创建一个新应用。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求头 该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

    请求语法 POST /pop/v1/wam/application HTTPS|HTTP 请求参数 名称 类型 是否必选 示例值 描述 AppName String 否 app1 新建应用的名称

    AppDescription String 否 This is an application 应用描述信息

    CategoryName String 否 Java 新建应用的平台类型

    UsingSharedStorage Boolean 否 true 是否使用共享OSS存储

    返回数据 名称 类型 示例值 描述 Application Struct 应用信息

    Code String OK 响应代码,若成功请求为OK

    Message String success 响应消息,若成功请求为success

    RequestId String BFD4C1BA-897D-4306-A79D-4D20D7E***** 请求ID

    示例 请求示例

    POST /pop/v1/wam/application HTTP/1.1 公共请求头 正常返回示例

    XML 格式

    success 27BE2428-060D-47DB-8A3C-CD86A53***** yourUsername app desc wa-5d3ea7cf2977ca5251e***** 1564387279787 1564387279787 Java yourUsername newApplication true OK JSON 格式

    { "Message": "success", "RequestId": "27BE2428-060D-47DB-8A3C-CD86A53*****", "Application": { "UpdateUsername": "yourUsername", "AppDescription": "app desc", "AppId": "wa-5d3ea7cf2977ca5251e*****", "CreateTime": 1564387279787, "UpdateTime": 1564387279787, "CategoryName": "Java", "CreateUsername": "yourUsername", "AppName": "newApplication", "UsingSharedStorage": true

    },
    "Code": "OK"
    

    } 错误码 HttpCode 错误码 错误信息 描述 404 CategoryNotExists The specified application category does not exist. 根据所使用的应用类型名称没有找到对应的记录,可能是配置错误或参数错误。 400 AppNameUsed The specified application name already exists in this region. Enter another application name. 创建应用时所使用的应用名称已被占用,请更换应用名称后重试。应用名在不同的地域下可重名。 访问错误中心查看更多错误码。

    调用DeleteApplication删除一个应用。

    说明 删除应用前需保证应用内所部署的所有环境均已处于已终止状态。 调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求头 该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

    请求语法 DELETE /pop/v1/wam/application HTTPS|HTTP 请求参数 名称 类型 是否必选 示例值 描述 AppId String 是 wa-5d1af9c802470221ab7***** 应用ID,将删除此应用

    返回数据 名称 类型 示例值 描述 RequestId String ED18C0F9-D542-4EE0-A3EE-BD71A6A***** 请求ID

    Code String OK 响应代码,若成功,则返回OK

    Message String success 响应消息,若成功,则返回success

    示例 请求示例

    http://webplus.cn-hangzhou.aliyuncs.com/pop/v1/wam/application?ServiceCode=webx&Id=wa-5d243437f314934e2a*****&<公共请求参数> 正常返回示例

    XML 格式

    success ED18C0F9-D542-4EE0-A3EE-BD71A6A***** OK JSON 格式

    { "Message": "success", "RequestId": "ED18C0F9-D542-4EE0-A3EE-BD71A6A*****", "Code": "OK" } 错误码 HttpCode 错误码 错误信息 描述 403 ResourceAuthFailed The specified resource does not exist or it does not belong to this Alibaba Cloud account. 相关资源不存在或不属于此阿里云账号。 403 AppDeleteNotAllowed You cannot delete this application. Make sure that all deployment environments in this application are terminated. 不允许删除该应用,如果该应用下有部署环境,需要确保所有环境均处于“已释放”状态才能删除应用,请检查对应环境的状态后重试。 404 DeletingEnvNotExists Deleting environment failed. The specified environment does not exist. 删除应用环境失败,将被删除的环境不存在。 400 EnvDeleteFailed An error occurred while deleting the application environment. This environment may have been deleted, or an error occurred while the server was deleting the environment configuration. 删除应用环境失败,有可能此环境之前已经被删除;或服务器删除环境配置时发生错误。 访问错误中心查看更多错误码。

    调用UpdateApplication更新应用。

    调试 您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    调试 请求头 该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

    请求语法 PUT /pop/v1/wam/application HTTP/1.1 请求参数 名称 类型 是否必选 示例值 描述 AppId String 是 wa-5d1af9c802470221ab7***** 应用ID,将更新此应用的信息

    AppDescription String 否 This is a updated Description 应用描述信息

    返回数据 名称 类型 示例值 描述 Application 返回的应用信息数据

    Code String OK 响应代码,若成功请求为OK

    Message String success 响应消息,若成功请求为success

    RequestId String 18A1F87E-591D-4491-90D5-2B101FA***** 请求ID

    示例 请求示例

    http://webplus.cn-hangzhou.aliyuncs.com/pop/v1/wam/application&<公共请求参数> { "AppId":"wa-5d1af9c802470221ab7*****", "AppDescription":"This is a updated Description" } 正常返回示例

    XML 格式

    success FBE82ECD-4200-4390-BEAC-B1CCF14***** Java user1 user1 1562048968834 wa-5d1af9c802470221ab7***** This is a updated Description 1564139945498 user1 OK JSON 格式

    { "Message":"success", "Application":{ "CategoryName":"Java", "UpdateUsername":"user1", "CreateUsername":"user1", "CreateTime":1562048968834, "AppId":"wa-5d1af9c802470221ab7*****", "UpdateTime":1564139945132, "AppDescription":"This is a updated Description", "AppName":"user1" }, "RequestId":"DBF81777-FD55-4A42-818F-FBC2F3E*****", "Code":"OK" } 错误码 HttpCode 错误码 错误信息 描述 403 ResourceAuthFailed The specified resource does not exist or it does not belong to this Alibaba Cloud account. 相关资源不存在或不属于此阿里云账号。 400 AppNotExist A corresponding application was not found based on the application ID. 根据应用 ID 没有找到对应的应用。 访问错误中心查看更多错误码。

    0 0
开发与运维
使用钉钉扫一扫加入圈子
+ 订阅

集结各类场景实战经验,助你开发运维畅行无忧

推荐文章
相似问题
推荐课程