适用版本 | 中心版、Region版 |
服务接入点与授权信息
产品 | 资源 | 所需权限 |
应用交付 | 应用 | 读写 |
请求语法
中心版
PUT https://{domain}/oapi/v1/appstack/organizations/{organizationId}/apps/{appName}
Region版
PUT https://{domain}/oapi/v1/appstack/apps/{appName}
请求头
参数 | 类型 | 是否必填 | 描述 | 示例值 |
x-yunxiao-token | string | 是 | 个人访问令牌。 | pt-0fh3****0fbG_35af****0484 |
请求参数
参数 | 类型 | 位置 | 是否必填 | 描述 | 示例值 |
appName | string | path | 是 | 应用名。 | my-web-service |
organizationId | string | path |
| 组织 ID。 | ec766e63aee3437d9a51f334d6exe671 |
| - | object | body | 否 | 应用信息修改入参。 | |
| description | string | body | 否 | 应用描述。 | 这是一个 Java 后端应用 |
| ownerAccountId | string | body | 否 | 应用 owner AccoundID。 | 240592939923074161 |
| ownerId | string | body | 否 | 应用 owner ID。 | bd9e3c6d-624f-4580-af7d-c5e26f1ed0f0 |
| tags | array[string] | body | 否 | 应用标签(覆盖式更新:如果不需要更新,调用该接口时可以不传该参数;空列表代表清空标签。)。 | ["后端服务", "Java"] |
请求示例
中心版
curl -X 'PUT' \
'https://{domain}/oapi/v1/appstack/organizations/ec766e63aee3437d9a51f334d6exe671/apps/my-web-service' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
--data '
{
"description": "这是一个Java后端应用",
"ownerAccountId": "240592939923074161",
"ownerId": "bd9e3c6d-624f-4580-af7d-c5e26f1ed0f0",
"tags": ["后端服务", "Java"]
}'
Region版
curl -X 'PUT' \
'https://{domain}/oapi/v1/appstack/apps/my-web-service' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
--data '
{
"description": "这是一个Java后端应用",
"ownerAccountId": "240592939923074161",
"ownerId": "bd9e3c6d-624f-4580-af7d-c5e26f1ed0f0",
"tags": ["后端服务", "Java"]
}'
返回参数
参数 | 类型 | 描述 | 示例值 |
| - | object | AppStack 应用模型。 | |
| appTemplateDisplayName | string | 应用模版展示名称。 | app-template-display-name |
| appTemplateName | string | 应用模版名称。 | app-template-name |
| creatorId | string | 应用创建者 ID。 | bd9e3c6d-624f-4580-af7d-c5e26f1ed0f0 |
| description | string | 描述。 | description |
| gmtCreate | string | 创建时间。 | 2024-09-01 00:00:00 |
| name | string | 应用名。 | app-name |
| tags | array[string] | 标签。 | ['java'] |
返回示例
{
"appTemplateDisplayName": "app-template-display-name",
"appTemplateName": "app-template-name",
"creatorId": "bd9e3c6d-624f-4580-af7d-c5e26f1ed0f0",
"description": "description",
"gmtCreate": "2024-09-01 00:00:00",
"name": "app-name",
"tags": ['java']
}
错误码
访问错误码中心查看 API 相关错误码。
该文章对您有帮助吗?