vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/cts/api-ref/ALL_META.TXT.json
Liu, Siying 61db61b4e5 CTS API 20230612 version. 
Reviewed-by: Bobkova, Natalia <natalia.bobkova@t-systems.com>
Co-authored-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-committed-by: Liu, Siying <liusiying@noreply.gitea.eco.tsi-dev.otc-service.com>
2024-04-18 10:17:02 +00:00

822 lines
23 KiB
JSON
Raw Blame History

[
{
"dockw":"API Reference"
},
{
"uri":"cts_api_0001.html",
"node_id":"cts_api_0001.xml",
"product_code":"cts",
"code":"1",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Before You Start",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"cts",
"opensource":"true"
}
],
"title":"Before You Start",
"githuburl":""
},
{
"uri":"cts_api_0030.html",
"node_id":"cts_api_0030.xml",
"product_code":"cts",
"code":"2",
"des":"Cloud Trace Service (CTS) is a log audit service designed to strengthen cloud security. It allows you to collect, store, and query resource operation records. You can use",
"doc_type":"api",
"kw":"Overview,Before You Start,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"cts",
"opensource":"true"
}
],
"title":"Overview",
"githuburl":""
},
{
"uri":"cts_api_0025.html",
"node_id":"cts_api_0025.xml",
"product_code":"cts",
"code":"3",
"des":"CTS supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.",
"doc_type":"api",
"kw":"API Calling,Before You Start,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"cts",
"opensource":"true"
}
],
"title":"API Calling",
"githuburl":""
},
{
"uri":"cts_api_0026.html",
"node_id":"cts_api_0026.xml",
"product_code":"cts",
"code":"4",
"des":"An endpoint is the request address for calling an API. Endpoints vary depending on services and regions. For the endpoints of CTS, see Regions and Endpoints.",
"doc_type":"api",
"kw":"Endpoints,Before You Start,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"cts",
"opensource":"true"
}
],
"title":"Endpoints",
"githuburl":""
},
{
"uri":"cts_api_0027.html",
"node_id":"cts_api_0027.xml",
"product_code":"cts",
"code":"5",
"des":"A maximum of 1 management tracker can be created in an account. The quotas cannot be modified.For more constraints, see API description.",
"doc_type":"api",
"kw":"Constraints,Before You Start,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"cts",
"opensource":"true"
}
],
"title":"Constraints",
"githuburl":""
},
{
"uri":"cts_api_0028.html",
"node_id":"cts_api_0028.xml",
"product_code":"cts",
"code":"6",
"des":"AccountAn account is created upon successful registration. The account has full access permissions for all of its cloud services and resources. It can be used to reset us",
"doc_type":"api",
"kw":"Concepts,Before You Start,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"cts",
"opensource":"true"
}
],
"title":"Concepts",
"githuburl":""
},
{
"uri":"cts_api_0029.html",
"node_id":"cts_api_0029.xml",
"product_code":"cts",
"code":"7",
"des":"It is recommended that you use the V3 APIs, which are more powerful and easy to use. The V1 APIs will be brought offline soon.",
"doc_type":"api",
"kw":"API Versions,Before You Start,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"cts",
"opensource":"true"
}
],
"title":"API Versions",
"githuburl":""
},
{
"uri":"cts_api_0002.html",
"node_id":"cts_api_0002.xml",
"product_code":"cts",
"code":"8",
"des":"With the extension APIs provided by CTS, you can use all CTS functions, such as querying the trace list, or creating a tracker.Table 1 lists CTS APIs.",
"doc_type":"api",
"kw":"API Overview,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"cts",
"opensource":"true"
}
],
"title":"API Overview",
"githuburl":""
},
{
"uri":"cts_api_0006.html",
"node_id":"cts_api_0006.xml",
"product_code":"cts",
"code":"9",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Calling APIs",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"cts",
"opensource":"true"
}
],
"title":"Calling APIs",
"githuburl":""
},
{
"uri":"cts_api_0007.html",
"node_id":"cts_api_0007.xml",
"product_code":"cts",
"code":"10",
"des":"This section describes the structure of a REST API request, and uses the IAM API for obtaining a user token as an example to demonstrate how to call an API. The obtained ",
"doc_type":"api",
"kw":"Making an API Request,Calling APIs,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"cts",
"opensource":"true"
}
],
"title":"Making an API Request",
"githuburl":""
},
{
"uri":"cts_api_0004.html",
"node_id":"cts_api_0004.xml",
"product_code":"cts",
"code":"11",
"des":"You can use either of the following authentication methods when calling APIs:Token-based authentication: Requests are authenticated using a token.AK/SK-based authenticati",
"doc_type":"api",
"kw":"Authentication,Calling APIs,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"cts",
"opensource":"true"
}
],
"title":"Authentication",
"githuburl":""
},
{
"uri":"cts_api_0024.html",
"node_id":"cts_api_0024.xml",
"product_code":"cts",
"code":"12",
"des":"After sending a request, you will receive a response, including a status code, response header, and response body.A status code is a group of digits, ranging from 1xx to ",
"doc_type":"api",
"kw":"Response,Calling APIs,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"cts",
"opensource":"true"
}
],
"title":"Response",
"githuburl":""
},
{
"uri":"cts_api_0008.html",
"node_id":"cts_api_0008.xml",
"product_code":"cts",
"code":"13",
"des":"This section describes how to create a tracker by calling APIs.The token obtained from IAM is valid for only 24 hours. If you want to use the same token for authenticatio",
"doc_type":"api",
"kw":"Getting Started,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"cts",
"opensource":"true"
}
],
"title":"Getting Started",
"githuburl":""
},
{
"uri":"cts_api_0101.html",
"node_id":"cts_api_0101.xml",
"product_code":"cts",
"code":"14",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"V3 APIs (Recommended)",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"cts",
"opensource":"true"
}
],
"title":"V3 APIs (Recommended)",
"githuburl":""
},
{
"uri":"topic_300000000.html",
"node_id":"topic_300000000.xml",
"product_code":"cts",
"code":"15",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Key Event Notification Management",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Key Event Notification Management",
"githuburl":""
},
{
"uri":"cts_api_0312.html",
"node_id":"cts_api_0312.xml",
"product_code":"cts",
"code":"16",
"des":"SMS, email, or HTTP/HTTPS notifications can be sent through pre-configured SMN topics to subscribers when key operations occur. This helps you detect high-risk operations",
"doc_type":"api",
"kw":"Creating a Key Event Notification,Key Event Notification Management,API Reference",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Creating a Key Event Notification",
"githuburl":""
},
{
"uri":"cts_api_0313.html",
"node_id":"cts_api_0313.xml",
"product_code":"cts",
"code":"17",
"des":"This API is used to modify a key event notification. The notification ID carried in the request must be valid.For details, see Calling APIs.PUT /v3/{project_id}/notificat",
"doc_type":"api",
"kw":"Modifying a Key Event Notification,Key Event Notification Management,API Reference",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Modifying a Key Event Notification",
"githuburl":""
},
{
"uri":"cts_api_0314.html",
"node_id":"cts_api_0314.xml",
"product_code":"cts",
"code":"18",
"des":"This API is used to delete a key event notification.For details, see Calling APIs.DELETE /v3/{project_id}/notificationsNoneStatus code: 400Status code: 401Status code: 40",
"doc_type":"api",
"kw":"Deleting a Key Event Notification,Key Event Notification Management,API Reference",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Deleting a Key Event Notification",
"githuburl":""
},
{
"uri":"cts_api_0315.html",
"node_id":"cts_api_0315.xml",
"product_code":"cts",
"code":"19",
"des":"This API is used to query a key event notification.For details, see Calling APIs.GET /v3/{project_id}/notifications/{notification_type}NoneStatus code: 200Status code: 40",
"doc_type":"api",
"kw":"Querying a Key Event Notification,Key Event Notification Management,API Reference",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Querying a Key Event Notification",
"githuburl":""
},
{
"uri":"cts_api_0310.html",
"node_id":"cts_api_0310.xml",
"product_code":"cts",
"code":"20",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Trace Management",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Trace Management",
"githuburl":""
},
{
"uri":"cts_api_0311.html",
"node_id":"cts_api_0311.xml",
"product_code":"cts",
"code":"21",
"des":"This API is used to query records of operations on resources in the last seven days.GET /v3/{project_id}/tracesNoneStatus code: 200Status code: 400Status code: 401Status ",
"doc_type":"api",
"kw":"Querying a Trace List,Trace Management,API Reference",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Querying a Trace List",
"githuburl":""
},
{
"uri":"cts_api_0320.html",
"node_id":"cts_api_0320.xml",
"product_code":"cts",
"code":"22",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Tracker Management",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Tracker Management",
"githuburl":""
},
{
"uri":"cts_api_0321.html",
"node_id":"cts_api_0321.xml",
"product_code":"cts",
"code":"23",
"des":"When you enable CTS, a tracker is automatically created to associate with the cloud services you are using and record all operations on the services. A management tracker",
"doc_type":"api",
"kw":"Creating a Tracker,Tracker Management,API Reference",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Creating a Tracker",
"githuburl":""
},
{
"uri":"cts_api_0322.html",
"node_id":"cts_api_0322.xml",
"product_code":"cts",
"code":"24",
"des":"This API is used to modify configurations of a tracker, including trace transfer to OBS buckets, key event notifications, trace file encryption, trace search and analysis",
"doc_type":"api",
"kw":"Modifying a Tracker,Tracker Management,API Reference",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Modifying a Tracker",
"githuburl":""
},
{
"uri":"cts_api_0323.html",
"node_id":"cts_api_0323.xml",
"product_code":"cts",
"code":"25",
"des":"After CTS is enabled, you can view details about the tracker on the Tracker page. The details include the name of the tracker, name of the OBS bucket for storing traces, ",
"doc_type":"api",
"kw":"Querying a Tracker,Tracker Management,API Reference",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Querying a Tracker",
"githuburl":""
},
{
"uri":"cts_api_0324.html",
"node_id":"cts_api_0324.xml",
"product_code":"cts",
"code":"26",
"des":"This API is used to delete a tracker. Deleting a tracker has no impact on the operation records that have been generated. When you enable CTS again, you can still view th",
"doc_type":"api",
"kw":"Deleting a Tracker,Tracker Management,API Reference",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Deleting a Tracker",
"githuburl":""
},
{
"uri":"cts_api_0330.html",
"node_id":"cts_api_0330.xml",
"product_code":"cts",
"code":"27",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Other APIs",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Other APIs",
"githuburl":""
},
{
"uri":"cts_api_0331.html",
"node_id":"cts_api_0331.xml",
"product_code":"cts",
"code":"28",
"des":"This API is used to querying tenant quota Information.GET /v3/{project_id}/quotasNoneStatus code: 200Status code: 400Status code: 401Status code: 403Status code: 404Statu",
"doc_type":"api",
"kw":"Querying Tenant Quota Information,Other APIs,API Reference",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Querying Tenant Quota Information",
"githuburl":""
},
{
"uri":"cts_api_0010.html",
"node_id":"cts_api_0010.xml",
"product_code":"cts",
"code":"29",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"API Version Management",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"API Version Management",
"githuburl":""
},
{
"uri":"cts_api_00325.html",
"node_id":"cts_api_00325.xml",
"product_code":"cts",
"code":"30",
"des":"This API is used to query all API versions supported by CTS.GET /NoneStatus code: 200NoneStatus code: 200The request is successful.For details, see Error Codes.",
"doc_type":"api",
"kw":"Querying All API Versions,API Version Management,API Reference",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Querying All API Versions",
"githuburl":""
},
{
"uri":"cts_api_0012.html",
"node_id":"cts_api_0012.xml",
"product_code":"cts",
"code":"31",
"des":"This API is used to query a specified API version of CTS.GET /{version}NoneStatus code: 200NoneStatus code: 200The request is successful.For details, see Error Codes.",
"doc_type":"api",
"kw":"Querying a Specific API Version,API Version Management,API Reference",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Querying a Specific API Version",
"githuburl":""
},
{
"uri":"cts_api_0009.html",
"node_id":"cts_api_0009.xml",
"product_code":"cts",
"code":"32",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Out-of-date APIs",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"cts",
"opensource":"true"
}
],
"title":"Out-of-date APIs",
"githuburl":""
},
{
"uri":"cts_api_0018.html",
"node_id":"cts_api_0018.xml",
"product_code":"cts",
"code":"33",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Trace Management",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Trace Management",
"githuburl":""
},
{
"uri":"cts_api_0019.html",
"node_id":"cts_api_0019.xml",
"product_code":"cts",
"code":"34",
"des":"This API is used to query records of operations on resources in the last seven days.GET /v1.0/{project_id}/{tracker_name}/traceNoneStatus code: 200Status code: 200The req",
"doc_type":"api",
"kw":"Querying Traces (v1.0),Trace Management,API Reference",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Querying Traces (v1.0)",
"githuburl":""
},
{
"uri":"cts_api_0903.html",
"node_id":"cts_api_0903.xml",
"product_code":"cts",
"code":"35",
"des":"This API is used to query records of operations on resources in the last seven days.GET /v2.0/{project_id}/{tracker_name}/traceNoneStatus code: 200Status code: 200The req",
"doc_type":"api",
"kw":"Querying Traces (v2.0),Trace Management,API Reference",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Querying Traces (v2.0)",
"githuburl":""
},
{
"uri":"cts_api_0013.html",
"node_id":"cts_api_0013.xml",
"product_code":"cts",
"code":"36",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Tracker Management",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Tracker Management",
"githuburl":""
},
{
"uri":"cts_api_0125.html",
"node_id":"cts_api_0125.xml",
"product_code":"cts",
"code":"37",
"des":"When you enable CTS, a tracker is automatically created to associate with the cloud services you are using and record all operations on the services. Currently, only one ",
"doc_type":"api",
"kw":"Creating a Tracker,Tracker Management,API Reference",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Creating a Tracker",
"githuburl":""
},
{
"uri":"cts_api_0016.html",
"node_id":"cts_api_0016.xml",
"product_code":"cts",
"code":"38",
"des":"This API is used to query the details of a tracker. The details include the name of the tracker, name of the OBS bucket for storing traces, and prefix of the trace files ",
"doc_type":"api",
"kw":"Querying a Tracker,Tracker Management,API Reference",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Querying a Tracker",
"githuburl":""
},
{
"uri":"cts_api_0017.html",
"node_id":"cts_api_0017.xml",
"product_code":"cts",
"code":"39",
"des":"This API is used to delete a tracker from CTS. Deleting a tracker has no impact on the operation records that have been generated. When you enable CTS again, you can stil",
"doc_type":"api",
"kw":"Deleting a Tracker,Tracker Management,API Reference",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Deleting a Tracker",
"githuburl":""
},
{
"uri":"cts_api_632.html",
"node_id":"cts_api_632.xml",
"product_code":"cts",
"code":"40",
"des":"This API is used to modify configurations of a tracker, including trace transfer to OBS buckets, key event notifications, trace file encryption, trace search and analysis",
"doc_type":"api",
"kw":"Modifying a Tracker,Tracker Management,API Reference",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"documenttype":"api",
"opensource":"true"
}
],
"title":"Modifying a Tracker",
"githuburl":""
},
{
"uri":"cts_api_0020.html",
"node_id":"cts_api_0020.xml",
"product_code":"cts",
"code":"41",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Appendix",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"cts",
"opensource":"true"
}
],
"title":"Appendix",
"githuburl":""
},
{
"uri":"ErrorCode.html",
"node_id":"errorcode_1.xml",
"product_code":"cts",
"code":"42",
"des":"HUAWEI CLOUD Help Center presents technical documents to help you quickly get started with HUAWEI CLOUD services. The technical documents include Service Overview, Price Details, Purchase Guide, User Guide, API Reference, Best Practices, FAQs, and Videos.",
"doc_type":"api",
"kw":"Error Codes,Appendix,API Reference",
"search_title":"",
"metedata":[
{
"prodname":"cts",
"opensource":"true",
"documenttype":"api"
}
],
"title":"Error Codes",
"githuburl":""
},
{
"uri":"cts_api_0005.html",
"node_id":"cts_api_0005.xml",
"product_code":"cts",
"code":"43",
"des":"Account ID (domain-id) and project ID are required for some URLs when an API is called. You can perform the following operations to obtain these IDs:Log in to the managem",
"doc_type":"api",
"kw":"Obtaining an Account ID and Project ID,Appendix,API Reference",
"search_title":"",
"metedata":[
{
"documenttype":"api",
"prodname":"cts",
"opensource":"true"
}
],
"title":"Obtaining an Account ID and Project ID",
"githuburl":""
}
]
View Git Blame Copy Permalink