华为云用户手册

URI GET /v3/projects 表1 Query参数 参数 是否必选 参数类型 描述 domain_id 否 String 项目所属账号ID，获取方式请参见：获取账号、 IAM 用户、项目、用户组、区域、委托的名称和ID。 enabled 否 Boolean 项目是否启用。 is_domain 否 Boolean 该字段无需填写。 name 否 String 项目名称，获取方式请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 page 否 Integer 分页查询时数据的页数，查询值最小为1。需要与per_page同时存在。 parent_id 否 String 如果查询自己创建的项目，则此处应填为所属区域的项目ID。 如果查询的是系统内置项目，如cn-north-1，则此处应填为账号ID。 获取项目ID和账号ID，请参见：获取账号、IAM用户、项目、用户组、区域、委托的名称和ID。 per_page 否 Integer 分页查询时每页的数据个数，取值范围为[1,5000]。需要与page同时存在。

响应参数 表3 响应Body参数 参数 参数类型 描述 region Object 区域信息。 表4 region 参数 参数类型 描述 description String 区域描述信息。 parent_region_id String 预埋字段，当前无实际意义，返回null。 links Object 区域的资源链接信息。 locales Object 区 域名 ，受区域信息注册影响，不一定返回对象中所有字段。 id String 区域ID。 type String 区域类型。 表5 region.links 参数 参数类型 描述 self String 资源链接地址。 表6 region.locales 参数 参数类型 描述 zh-cn String 区域的中文名称。 en-us String 区域的英文名称。 pt-br String 区域的葡萄牙语名称。 es-us String 区域的美国西班牙语名称。 es-es String 区域的西班牙语名称。

响应示例 状态码为 200 时: 请求成功。 { "region": { "description": "", "links": { "self": "https://iam.myhuaweicloud.com/v3/regions/la-south-2" }, "type": "public", "id": "la-south-2", "locales": { "pt-br": "AL-Santiago", "zh-cn": "拉美-圣地亚哥", "en-us": "LA-Santiago", "es-us": "AL-Santiago de Chile1", "es-es": "LA-Santiago" } } }

响应参数 表2 响应Body参数 参数 参数类型 描述 links Object 资源链接信息。 regions Array of objects 区域信息列表。 表3 links 参数 参数类型 描述 self String 资源链接地址。 previous String 前一邻接资源链接地址，不存在时为null。 next String 后一邻接资源链接地址，不存在时为null。 表4 regions 参数 参数类型 描述 description String 区域描述信息。 parent_region_id String null. links Object 区域的资源链接信息。 locales Object 区域名，受区域信息注册影响，不一定返回对象中所有字段。 id String 区域ID。 type String 区域类型。 表5 regions.links 参数 参数类型 描述 self String 资源链接地址。 表6 regions.locales 参数 参数类型 描述 zh-cn String 区域的中文名称。 en-us String 区域的英文名称。 pt-br String 区域的葡萄牙语名称。 es-us String 区域的美国西班牙语名称。 es-es String 区域的西班牙语名称。

响应示例 状态码为 200 时: 请求成功。 { "regions": [ { "parent_region_id": null, "description": "", "links": { "self": "https://iam.myhuaweicloud.com/v3/regions/cn-north-1" }, "type": "public", "id": "cn-north-1", "locales": { "zh-cn": "华北-北京一", "en-us": "cn-north-1" } }, { "parent_region_id": null, "description": "", "links": { "self": "https://iam.myhuaweicloud.com/v3/regions/la-south-2" }, "type": "public", "id": "la-south-2", "locales": { "pt-br": "AL-Santiago", "zh-cn": "拉美-圣地亚哥", "en-us": "LA-Santiago", "es-us": "AL-Santiago de Chile1", "es-es": "LA-Santiago" } } ], "links": { "self": "https://iam.myhuaweicloud.com/v3/regions", "previous": null, "next": null } }

响应示例 状态码为 201 时: 创建成功。 无论session_user填写与否，返回都是相同的。若填写了session_user，则在securitytoken中包含了所填写的session_user信息。 { "credential": { "access": "E6DX0TF2ZREQ4Z...", "expires_at": "2020-01-08T02:56:19.587000Z", "secret": "w9ePum0qdfac39ErLD0UdjofYkqort6Iw....", "securitytoken": "gQpjbi1ub3J0aC0..." } }

响应参数 表9 响应Body参数 参数 参数类型 描述 credential Object 认证结果信息。 表10 credential 参数 参数类型 描述 expires_at String AK/SK和securitytoken的过期时间。响应参数为UTC时间格式，北京时间为UTC+8小时。 如返回： "expires_at": "2020-01-08T02:56:19.587000Z" 北京时间：2020-01-08 10:56:19.587 access String 获取的AK。 secret String 获取的SK。 securitytoken String securitytoken是将所获的AK、SK等信息进行加密后的字符串。

请求示例 填写"session_user"参数，即委托方对应的企业用户信息，包含委托方对应的企业用户名。 POST https://iam.myhuaweicloud.com/v3.0/OS-CREDENTIAL/securitytokens { "auth": { "identity": { "methods": [ "assume_role" ], "assume_role": { "domain_name": "IAMDomainA", "agency_name": "IAMAgency", "duration_seconds": 3600, "session_user": { "name": "SessionUserName" } } } } } 填写"policy"参数，即用户自定义策略的信息，用于限制获取到的临时访问密钥和securitytoken的权限（当前仅适用限制OBS服务的权限）。如果填写此参数，则临时访问密钥和securitytoken的权限为：委托具有的权限和policy参数限制的权限交集。 POST https://iam.myhuaweicloud.com/v3.0/OS-CREDENTIAL/securitytokens { "auth": { "identity": { "methods": [ "assume_role" ], "policy": { "Version": "1.1", "Statement": [{ "Effect": "allow", "Action": [ "obs:object:*" ], "Resource": ["obs:*:*:object:*"], "Condition": { "StringEquals": { "obs:prefix": ["public"] } } }] }, "assume_role": { "domain_name": "IAMDomainA", "agency_name": "IAMAgency", "duration_seconds": 3600 } } } } 不填写"session_user"和policy参数。 POST https://iam.myhuaweicloud.com/v3.0/OS-CREDENTIAL/securitytokens { "auth": { "identity": { "methods": [ "assume_role" ], "assume_role": { "domain_name": "IAMDomainA", "agency_name": "IAMAgency", "duration_seconds": 3600 } } } }

功能介绍 该接口可以用于通过委托来获取临时访问密钥（临时AK/SK）和securitytoken。 临时AK/SK和securitytoken是系统颁发给IAM用户的临时访问令牌，有效期可在15分钟至24小时范围内设置，过期后需要重新获取。临时AK/SK和securitytoken遵循权限最小化原则。鉴权时，临时AK/SK和securitytoken必须同时使用，请求头中需要添加“x-security-token”字段，使用方法详情请参考：使用临时AK/SK做签名 该接口可以使用全局区域的Endpoint和其他区域的Endpoint调用。IAM的Endpoint请参见：地区和终端节点。

功能介绍 该接口可以用于通过unscoped token来获取临时AK/SK和securitytoken。临时AK/SK和securitytoken是系统颁发给IAM用户的临时访问令牌，有效期可在15分钟至24小时范围内设置，过期后需要重新获取。临时AK/SK和securitytoken遵循权限最小化原则。 该接口可以使用全局区域的Endpoint和其他区域的Endpoint调用。IAM的Endpoint请参见：地区和终端节点。 使用获取到的临时AK/SK和securitytoken作为凭证访问云服务，临时AK/SK和securitytoken两者必须同时使用，请求头中需要添加“x-security-token”字段，使用方法详情请参考：使用临时AK/SK做签名。

响应参数 表8 响应Body参数 参数 参数类型 描述 credential Object 认证结果信息。 表9 credential 参数 参数类型 描述 expires_at String AK/SK和securitytoken的过期时间。响应参数为UTC时间格式，北京时间为UTC+8小时。 如返回： "expires_at": "2020-01-08T02:56:19.587000Z" 北京时间：2020-01-08 10:56:19.587 access String 获取的AK。 secret String 获取的SK。 securitytoken String securitytoken是将所获的AK、SK等信息进行加密后的字符串。

响应示例 状态码为 201 时: 创建成功。 { "credential": { "access": "NZFAT5VNWEJDGZ4PZ...", "expires_at": "2020-01-08T03:50:07.574000Z", "secret": "riEoWsy3qO0BvgwfkoLVgCUvzgpjBBcvdq...", "securitytoken": "gQpjbi1ub3J0aC00jD4Ej..." } }

请求示例 填写"token"参数。包含tokenId（即token）和临时访问密钥和securitytoken的有效期。 POST https://iam.myhuaweicloud.com/v3.0/OS-CREDENTIAL/securitytokens { "auth": { "identity": { "methods": [ "token" ], "token": { "id": "MIIEIgYJKoZIhvc...", "duration_seconds": "900" } } } } 不填写“token”参数（请求头中需要X-Auth-Token）。 POST https://iam.myhuaweicloud.com/v3.0/OS-CREDENTIAL/securitytokens { "auth": { "identity": { "methods": [ "token" ] } } } 填写“policy”参数。即用户自定义策略的信息，用于限制获取到的临时访问密钥和securitytoken的权限（当前仅适用限制OBS服务的权限）。如果填写此参数，则临时访问密钥和securitytoken的权限为：原Token具有的权限和policy参数限制的权限交集。 POST https://iam.myhuaweicloud.com/v3.0/OS-CREDENTIAL/securitytokens { "auth": { "identity": { "methods": [ "token" ], "policy": { "Version": "1.1", "Statement": [ { "Effect": "Allow", "Action": [ "obs:object:GetObject" ], "Resource": [ "OBS:*:*:object:*" ], "Condition": { "StringEquals": { "g:DomainName": [ "DomainNameExample" //示例，表示限制条件值，根据实际情况填写 ] } } } ] }, "token": { "duration_seconds": 900 } } } }

状态码 正常 返回值 说明 200 OK 请求成功。 201 Created 请求处理成功。 202 Accepted 任务提交成功，当前系统繁忙，下发的任务会延迟处理。 204 No Content 任务提交成功。 异常 返回值 说明 300 multiple choices 被请求的资源存在多个可供选择的响应。 400 Bad Request 服务器未能处理请求。 401 Unauthorized 被请求的页面需要用户名和密码。 403 Forbidden 对被请求页面的访问被禁止。 404 Not Found 服务器无法找到被请求的页面。 405 Method Not Allowed 请求中指定的方法不被允许。 406 Not Acceptable 服务器生成的响应无法被客户端所接受。 407 Proxy Authentication Required 用户必须首先使用代理服务器进行验证，这样请求才会被处理。 408 Request Timeout 请求超出了服务器的等待时间。 409 Conflict 由于冲突，请求无法被完成。 429 Request Entity Too Large 超出流控值限制。 500 Unsupported Media Type 请求未完成。服务异常。 501 Too Many Requests 请求未完成。服务器不支持所请求的功能。 502 Internal Server Error 请求未完成。服务器从上游服务器收到一个无效的响应。 503 Not Implemented 请求未完成。系统暂时异常。 504 Service Unavailable 网关超时。 父主题： 附录

调用API获取项目ID 项目ID可以通过调用查询指定条件下的项目列表API获取。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects”，其中{Endpoint}为IAM的终端节点，可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下，其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "project_name", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }

事件归属 事件单涉及的状态如表5所示。 表5 事件归属 status KEY 中文名称 英文名称 incident_ownership_100 告警发现 Alarm Discovery incident_ownership_200 客户报障 Customer Report Faults incident_ownership_300 主动运维 Proactive Operation And Maintenance incident_ownership_1000 其他 Other

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Token可通过调用获取用户Token接口获取。 调用本服务API需要项目级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", //IAM用户名 "password": "********", //IAM用户密码 "domain": { "name": "domainname" //IAM用户所属账号名 } } } }, "scope": { "project": { "name": "xxxxxxxx" //项目名称 } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFG....”，则调用接口时将“X-Auth-Token: ABCDEFG....”加到请求消息头即可，如下所示。 1 2 3 GET https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFG.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333。

AK/SK认证 AK/SK签名认证方式仅支持消息体大小在12MB以内，12MB以上的请求请使用Token认证。 AK/SK认证就是使用AK/SK对请求进行签名，在请求时将签名信息添加到消息头，从而通过身份认证。 AK（Access Key ID）：访问密钥ID。与私有访问密钥关联的唯一标识符；访问密钥ID和私有访问密钥一起使用，对请求进行加密签名。 SK（Secret Access Key）：私有访问密钥。与访问密钥ID结合使用，对请求进行加密签名，可标识发送方，并防止请求被修改。 使用AK/SK认证时，您可以基于签名算法使用AK/SK对请求进行签名，也可以使用专门的签名SDK对请求进行签名。详细的签名方法和SDK使用方法请参见API签名指南。 签名SDK只提供签名功能，与服务提供的SDK不同，使用时请注意。

请求消息体（可选） 该部分可选。请求消息体通常以结构化格式（如JSON或XML）发出，与请求消息头中Content-Type对应，传递除请求消息头之外的内容。若请求消息体中的参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-1”，您可以从地区和终端节点获取。 scope参数定义了Token的作用域，下面示例中获取的Token仅能访问project下的资源。您还可以设置Token的作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中的“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 详细的公共请求消息头字段请参见公共请求消息头。 表3 公共请求消息头 名称 描述 是否必选 示例 Host 请求的服务器信息，从服务API的URL中获取。值为hostname[:port]。端口缺省时使用默认的端口，https的默认端口为443。 否 使用AK/SK认证时该字段必选。 code.test.com or code.test.com:443 Content-Type 消息体的类型（格式）。推荐用户使用默认值application/json，有其他取值时会在具体接口中专门说明。 是 application/json Content-Length 请求body长度，单位为Byte。 否 3495 X-Project-Id project id，项目编号。请参考获取项目ID章节获取项目编号。 否 如果是专属云场景采用AK/SK认证方式的接口请求，或者多project场景采用AK/SK认证的接口请求，则该字段必选。 e9993fc787d94b6c886cbaa340f9c0f4 X-Auth-Token 用户Token。 用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头（Headers）中包含的“X-Subject-Token”的值即为Token值。 否 使用Token认证时该字段必选。 注：以下仅为Token示例片段。 MIIPAgYJKoZIhvcNAQcCo...ggg1BBIINPXsidG9rZ API同时支持使用AK/SK认证，AK/SK认证使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见认证鉴权的“AK/SK认证”。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 1 2 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求URI 请求URI由如下部分组成： {URI-scheme}://{Endpoint}/{resource-path}?{query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 表1 URI中的参数说明 参数 描述 URI-scheme 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint 指定承载REST服务端点的服务器域名或IP，不同服务不同区域的Endpoint不同，您可以从地区和终端节点获取。 例如IAM服务在“华北-北京四”区域的Endpoint为“iam.cn-north-4.myhuaweicloud.com”。 resource-path 资源路径，即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“?”，形式为“参数名=参数取值”，例如“?limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京四”区域的Token，则需使用“华北-北京四”区域的Endpoint（iam.cn-north-4.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 1 https://iam.cn-north-4.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为方便查看，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，而Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务您正在请求什么类型的操作。 表2 HTTP方法 方法 说明 GET 请求服务器返回指定资源。 PUT 请求服务器更新指定资源。 POST 请求服务器新增资源或执行特殊操作。 DELETE 请求服务器删除指定资源，如删除对象等。 HEAD 请求服务器资源头部。 PATCH 请求服务器更新资源的部分内容。 当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： 1 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

基本概念 账号 用户注册时的账号，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户并使用用户进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和IAM用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域（Region） 从地理位置和网络时延维度划分，同一个Region内共享弹性计算、块存储、对象存储、VPC网络、弹性公网IP、镜像等公共服务。Region分为通用Region和专属Region，通用Region指面向公共租户提供通用云服务的Region；专属Region指只承载同一类业务或只面向特定租户提供业务服务的专用Region。 详情请参见区域和可用区。 可用区（AZ，Availability Zone） 一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中的资源，使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下，您可以查看项目ID。 企业项目 企业项目是项目的升级版，针对企业不同项目间的资源进行分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。

请求示例 修改SHELL脚本请求体示例。 PUT https://{Endpoint}/v1/job/scripts/SC2023110211155901a700000 { "type" : "SHELL", "content" : "echo ${a}", "name" : "019101112", "description" : "修改", "properties" : { "risk_level" : "HIGH", "version" : "1.1.1", "reviewers" : [ ] }, "script_params" : [ { "param_name" : "a", "param_value" : "string", "param_description" : "string", "param_order" : 1, "sensitive" : true } ] }

接口约束 约束条件： 脚本名称：同一租户下，脚本名称不能重复，最大字符64个字符，支持中文+字母+数字+下划线。 脚本内容最大4096个字符。 脚本参数个数最多20个。 脚本描述：最大256个字符。 单个参数的参数名称 64个字符，只支持字母+数字+下划线。 单个参数的值最大1024个字符，正则表达式如下：^((?!.{2,})[a-zA-Z0-9_-/.\x20?:",=+@[{]}])$。 修改的脚本如果有审批人，在修改之后，需要再次选择审批人，查询审批

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 租户token。 X-Language 否 String 国际化标记，zh-cn表示中文，en-us或不传表示英文。 x-project-id 否 String 项目ID。 x-user-profile 否 String IAM5.0用户信息。 表3 请求Body参数 参数 是否必选 参数类型 描述 description 是 String 脚本描述。 content 是 String 脚本内容。 properties 否 ScriptPropertiesModel object 风险等级：LOW；HIGH；MEDIUM；审批人只支持修改。 script_params 否 Array of ScriptParamDefine objects 脚本入参 表4 ScriptPropertiesModel 参数 是否必选 参数类型 描述 risk_level 是 String 风险等级。 LOW：低风险。 MEDIUM：中风险。 HIGH：高风险。 version 是 String 脚本版本号。 reviewers 否 Array of ReviewerInfo objects 审批人，不填写不需要审批。 protocol 否 String 审批 消息通知 协议，用于通知审批人。 DEFAULT：默认。 SMS ：短信。 EMAIL：邮件。 DING_TALK：钉钉。 WE_LINK：welink。 WECHAT：微信。 CALLNOTIFY：语言。 NOT_TO_NOTIFY：不通知。 表5 ReviewerInfo 参数 是否必选 参数类型 描述 reviewer_name 是 String 审批人名称（IAM用户名）。 reviewer_id 是 String 审批人ID（IAM用户Id）。 表6 ScriptParamDefine 参数 是否必选 参数类型 描述 param_name 是 String 参数名仅支持字母、数字以及下划线。 param_value 是 String 参数值。 约束： 参数长度为1-4096位。 可以包含大写字母、小写字母、数字及特殊字符(_-/.* ?:",=+@#[{]})。 禁止出现连续'.'。 param_description 是 String 参数描述。 param_order 是 Integer 【已废弃】该参数已废弃，传入该参数不会生效。 sensitive 是 Boolean 是否是敏感参数。

请求示例 变更结束。 PUT https://{Endpoint}/v2/changes/{change_id} { "history_info": { "action": "change_end_change_success" }, "sub_tickets": [ { "ticket_id": " 92f0c22f-4ca4-4cbe-89cf-281aed331f50" } ] }

请求参数 表2 请求body参数列表 名称 类型 是否必选 描述 ticket_info TicketInfoObject 否 变更主单信息。 默认取值：不涉及 sub_tickets Arrays of SubTicketInfoObject 否 变更子单信息。 数组长度：1 - 1024 默认取值：不涉及 history_info TicketHistoryInfoObject 否 变更历史信息。 默认取值：不涉及 表3 TicketInfoObject属性： 名称 类型 是否必选 描述 phase String 否 工单阶段。 最小长度：0 最大长度：255 默认取值：不涉及 work_flow_status String 否 工单状态。 最小长度：0 最大长度： 255 默认取值：不涉及 表4 TicketInfoObject属性： 名称 类型 是否必选 描述 ticket_id String 否 子单ID。 最小长度：0 最大长度：100 默认取值：不涉及 change_result String 否 变更结果。 最小长度：0 最大长度：100 默认取值：不涉及 is_verified_in_change_time Boolean 否 工单状态。 默认取值：不涉及 枚举值： true false verified_docs String 否 验证文档ID。 最小长度：0 最大长度：1000 默认取值：不涉及 comment String 否 失败原因描述。 最小长度：0 最大长度：100 默认取值：不涉及 change_fail_type String 否 变更失败类型。 最小长度：0 最大长度：100 默认取值：不涉及 rollback_start_time Long 否 回退开始时间。 最小值：1 最大值：9999999999999 默认取值：不涉及 rollback_end_time Long 否 回退结束时间。 最小值：1 最大值：9999999999999 默认取值：不涉及 is_rollback_success Boolean 否 是否回退成功。 默认取值：不涉及 枚举值： true false is_monitor_found Boolean 否 是否被监控发现。 默认取值：不涉及 枚举值： true false 表5 TicketInfoObject属性： 名称 类型 是否必选 描述 action String 否 操作类型。 最小长度：0 最大长度：1000 取值： change_end_change_success：变更结束 change_set_change_result_success：添加变更结果 change_complete_success：关单 默认取值：不涉及

响应参数 状态码：200 表6 响应Body参数列表 名称 类型 是否必选 描述 provider_code String 否 服务标识。 缺省值：049 最小长度：0 最大长度：256 error_code String 否 请求响应代码，范围：0000~9999，正常时取值：0。 缺省值：0 最小长度：0 最大长度：256 error_msg String 否 请求响应描述。 最小长度：0 最大长度：256

响应示例 状态码：200 请求成功。 更多状态码请参考状态码。 { "data" : { "script_uuid" : "SC20230831110xxx", "name" : "testExxx", "description" : "测试xx", "type" : "SHELL", "content" : "echo \"${aaa}\"", "script_params" : [ { "param_name" : "value", "param_value" : "aaa", "param_description" : "测试参数", "param_order" : 1, "sensitive" : false } ], "gmt_created" : 1686059454716, "gmt_modified" : 1745222192134, "status" : "APPROVED", "creator" : "COC-TEST", "creator_id" : "1994a3ed905a47ad82c6xxxxxxx", "operator" : "COC-TEST", "properties" : { "risk_level" : "LOW", "version" : "v1.0.0" }, "enterprise_project_id" : 0 } }