云控制API调试工具操作指南

更新时间:
复制 MD 格式

本文为您介绍云控制API-调试工具的主要功能。调试工具是云控制API的图形化界面工具,支持资源信息查看和API调用,帮助您便捷地管理资源。如果您想体验通过调试工具实现资源的全生命周期管理,请参见通过OpenAPI门户实现资源管理

查看资源信息

通过调试工具,您可以方便地查看资源的详细信息。

查看支持的产品及资源

可查看所有已支持的产品及其资源。

OpenAPI 门户页面左侧边栏选择云产品(如专有网络VPC),即可查看该产品下的资源分类列表,包括公网IP地址池(PublicIpAddressPool)、VPC前缀列表(PrefixList)、流量镜像筛选条件(TrafficMirrorFilter)、Ipv4网关(Ipv4Gateway)、流日志(FlowLog)、高可用虚拟IP(HaVip)、路由表(RouteTable)、交换机(VSwitch)、专有网络(VPC)等。选中某一资源后,在主内容区域的资源属性页签可查看属性名称、类型、是否创建必填、是否允许更新、是否只读及描述等信息。

查看资源的详细信息

单击资源名称,右侧将显示该资源的资源属性资源元数据

其中 资源属性 页签展示资源简介(资源类型、所属产品、部署级别、付费类型)以及属性表格,表格列包括属性名称、类型、创建必填、允许更新、是否只读和描述。

查看授权策略

如需配置自定义权限策略,可参考资源的授权策略。

在 OpenAPI 门户左侧选择专有网络VPC,在主内容区单击授权策略页签,即可查看资源操作与鉴权 Action 的对应关系。例如,资源创建对应 vpc:CreateVpc,资源更新对应 vpc:TagResourcesvpc:AssociateVpcCidrBlockvpc:MoveResourceGroupvpc:ModifyVpcAttributevpc:UnTagResourcesvpc:UnassociateVpcCidrBlockvpc:EnableVpcClassicLinkvpc:DisableVpcClassicLinkvpc:ListTagResources 等。

调用API

选择资源操作

您可以选择资源的创建、更新、获取、列举与删除操作。

在左侧导航树中展开专有网络 VPC节点,可看到CreateResourceUpdateResourceGetResourceGetResourcesDeleteResource五个操作入口,单击所需操作即可在右侧查看请求参数配置与多语言示例代码。

填写参数并调用

提供界面化的参数填写方式,并包含参数的类型和描述等信息,帮助您快速完成参数填写。单击发起调用即可开始调用。

界面左侧导航栏可选择目标 API,中部为请求参数表单(包含服务地址请求路径regionIdnextTokenmaxResults 等参数输入框),右侧展示对应的 SDK 示例代码。

示例代码

根据已填写的参数,动态生成多种语言的示例代码。

在页面右侧面板中,单击示例代码 Tab 页签可查看生成的代码。语言选择栏支持 Java(异步)、Java、TypeScript、Go、PHP、Python、C#、C++、Swift、Node.js。代码面板上方提供运行示例下载完整工程按钮。

调用结果

展示调用结果,并提供查看日志去诊断的快捷方式。

调用成功时,页面显示绿色状态标识、状态码 200 及响应耗时,下方展示 JSON 格式的响应体(包含 requestIdresources 等字段)和 Request Header 详情。

异步任务管理

提供异步任务的查询任务取消任务的快捷方式,方便您管理异步任务。