检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
换为500 最小值:1 最大值:500 缺省值:20 permission 否 String 权限账号ID,格式为“iam:domain::domain_id”,支持模糊搜索 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String
API分组状态 1 正常状态 2 禁用状态 3 已删除 默认值1 该字段暂时废弃 R - SL_DOMAIN String API分组的子域名,由API网关分配,用户不可填写和修改 R - SL_DOMAINS Array of strings API分组的子域名列表,由API网关分配,用户不可填写和修改
参数类型 描述 task_id String 任务id task_status String 任务状态。waiting等待处理,processing处理中,succeed成功,failed失败。 task_type String 任务类型。 import_api为异步导入api,export_api为异步导出api。
400 非法请求 检查请求是否合法。 APIG.0605 Domain name resolution failed. 500 域名解析失败 检查域名拼写,以及域名是否绑定了正确的后端地址。 APIG.0606 Failed to load the API configurations
状态码: 412 PreconditionFailed { "error_code" : "APIG.3415", "error_msg" : "The API group cannot be deleted because it contains APIs,id:47eaed4
表4 参数说明 名称 类型 说明 success_count Number 删除成功的ACL策略数量 failure Array 删除失败的ACL策略及错误信息 表5 failure参数说明 名称 类型 说明 acl_id String 删除失败的ACL策略ID acl_name
/v1/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate/{id} URI中的参数说明如下表所示。 表2 参数说明 名称 是否必选 类型 说明 project_id
名称 acl_type 否 String 类型:PERMIT或DENY entity_type 否 String 作用的对象类型:IP或DOMAIN page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 precise_search
字典数据类型:分组字段说明 名称 类型 说明 id String 编号 name String 名称 status Integer 状态 sl_domain String 系统默认分配的子域名 register_time Timestamp 创建时间 update_time Timestamp
入门实践 您可以根据自身的业务需求使用APIG提供的一系列常用实践。 表1 常用最佳实践 实践 描述 使用函数服务开发自定义认证 在API的安全认证方面,API网关提供IAM认证、APP认证等方式,帮助用户快速开放API,同时API网关也支持用户使用自己的认证方式(以下简称自定义认证),以便更好地兼容已有业务能力。
/v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}/certificate 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,获取方式请参见获取项目ID。
正常响应示例,描述API的正常返回信息 result_failure_sample String 失败返回示例,描述API的异常返回信息 response_id String 分组自定义响应ID sl_domain String 分组的二级域名 sl_domains Array of strings
表4 参数说明 名称 类型 说明 success_count Number 删除成功的ACL策略数量 failure Array 删除失败的ACL策略及错误信息 表5 failure参数说明 名称 类型 说明 acl_id String 删除失败的ACL策略ID acl_name
DOMAIN update_time Timestamp 更新时间 响应消息样例: { "id": "d402b35e-1054-4280-b1c5-0d741a28c995", "acl_name": "goodone", "entity_type": "DOMAIN",
参数 参数类型 描述 success Array of PublishResp objects 发布或下线成功的信息 failure Array of BatchFailure objects 发布或下线失败的API及错误信息 表6 PublishResp 参数 参数类型 描述 publish_id
仅在“Method”为“PATCH”/“POST”/“PUT”时,支持修改。 添加请求参数后,单击“发送请求”。 右侧返回结果回显区域打印API调用的Response信息。 开发者可以通过调整请求参数与参数值,发送不同的请求,验证API服务。 父主题: 共享版操作指导(仅存量用户使用)
String 错误描述 请求示例 为API分组绑定域名 { "url_domain" : "www.company.com" } 响应示例 状态码: 201 Created { "url_domain" : "www.company.com", "id" : "c5e0d
Timestamp 订购时间 start_time Timestamp 生效时间 expire_time Timestamp 过期时间 group_domains []String 分组访问域名列表,查询列表时不返回 quota_left Integer 剩余访问次数 quota_used Integer
run_env_id String 发布的环境id publish_id String 发布记录的编号 sl_domain String 分组的二级域名 sl_domains Array of strings 系统默认分配的子域名列表 req_params Array of ReqParam
名称 acl_type 否 String 类型:PERMIT或DENY entity_type 否 String 作用的对象类型:IP或DOMAIN page_size 否 Integer 每页显示的条数,默认值:20 page_no 否 Integer 页码,默认值:1 precise_search