
# 根据环境ID刷新环境 - RefreshEnvironmentBasedOnTheEnvironmentID
#### 功能介绍
此API用于下发环境的刷新任务。
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-servicestage/servicestage_06_0183.html)。
- 如果使用身份策略授权，需具备如下身份策略权限。
  
  | 授权项                              | 访问级别  | 资源类型（\*为必须）    | 条件键                                                                                                                                                                                                                                                                                                                                                                                                     | 别名 | 依赖的授权项 |
  |:---|:---|:---|:---|:---|:---|
  | servicestage:environment:refresh | write | environment \* | - [g:EnterpriseProjectId](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html)  - [g:ResourceTag/\<tag-key\>](https://support.huaweicloud.com/usermanual-iam5/iam_01_1287.html)   | -  | -      |
     
  
 
#### URI
POST /v3/{project_id}/cas/environments/{environment_id}/refresh
表1路径参数 
| 参数             | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| project_id     | 是    | String | **参数解释：** 租户项目ID。获取方法，请参考[获取项目ID](https://support.huaweicloud.com/api-servicestage/servicestage_06_0164.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
| environment_id | 是    | String | **参数解释：** 环境ID。获取方法，请参考[获取所有环境 - ObtainAllEnvironments](https://support.huaweicloud.com/api-servicestage/servicestage_06_0057.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                               |
   
#### 请求参数
表2请求Header参数 
| 参数           | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
|:---|:---|:---|:---|
| Content-Type | 是    | String | **参数解释：** 消息体的类型（格式）。 **约束限制：** 不涉及 **取值范围：** application/json;charset=utf8 **默认取值：** 不涉及                                                                                                                              |
| X-Auth-Token | 是    | String | **参数解释：** 调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。Token获取方式，请参考[认证鉴权](https://support.huaweicloud.com/api-servicestage/servicestage_06_0010.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
#### 响应消息
表3响应参数 
| 参数             | 参数类型   | 描述                                                                                                                                                                                                                                          |
|:---|:---|:---|
| job_id         | String | **参数解释：** 刷新任务ID。 **取值范围：** 不涉及    |
| environment_id | String | **参数解释：** 环境ID **取值范围：** 不涉及 |
   
#### 请求示例
无。
#### 响应示例
```
{
    "job_id": "JOB8c8573a0-012f-4d65-9d5b-1e244f375a7b",
    "environment_id": "bd30574b-2ed1-44d1-82c8-24a0e528ec37"
}
```
#### 状态码
| 状态码 | 描述      |
|:---|:---|
| 200 | 操作成功    |
| 400 | 错误的请求   |
| 404 | 请求对象不存在 |
| 500 | 内部错误    |
   
#### 错误码
请参考[ServiceStage错误码](https://support.huaweicloud.com/api-servicestage/servicestage_06_0162.html)。
