diff --git a/docs/config/api-ref/ALL_META.TXT.json b/docs/config/api-ref/ALL_META.TXT.json new file mode 100644 index 00000000..19499062 --- /dev/null +++ b/docs/config/api-ref/ALL_META.TXT.json @@ -0,0 +1,1283 @@ +[ + { + "dockw":"API Reference" + }, + { + "uri":"rms_01_0000.html", + "node_id":"rms_01_0000.xml", + "product_code":"config", + "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":"config" + } + ], + "title":"Before You Start", + "githuburl":"" + }, + { + "uri":"rms_01_0100.html", + "node_id":"rms_01_0100.xml", + "product_code":"config", + "code":"2", + "des":"With Config, you can search for, record, and continuously evaluate your resource configuration to make sure that your expectations are met.This document describes the Con", + "doc_type":"api", + "kw":"Introduction,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Introduction", + "githuburl":"" + }, + { + "uri":"rms_01_0200.html", + "node_id":"rms_01_0200.xml", + "product_code":"config", + "code":"3", + "des":"Config 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":"config" + } + ], + "title":"API Calling", + "githuburl":"" + }, + { + "uri":"rms_01_0500.html", + "node_id":"rms_01_0500.xml", + "product_code":"config", + "code":"4", + "des":"AccountAn account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account ", + "doc_type":"api", + "kw":"Concepts,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Concepts", + "githuburl":"" + }, + { + "uri":"rms_01_0600.html", + "node_id":"rms_01_0600.xml", + "product_code":"config", + "code":"5", + "des":"Some Config APIs support pagination query if you add limit and marker to the request URL. The value of marker must be the same as that returned in the last pagination que", + "doc_type":"api", + "kw":"Querying Data by Page,Before You Start,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying Data by Page", + "githuburl":"" + }, + { + "uri":"rms_02_0000.html", + "node_id":"rms_02_0000.xml", + "product_code":"config", + "code":"6", + "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 Overview,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"API Overview", + "githuburl":"" + }, + { + "uri":"rms_03_0000.html", + "node_id":"rms_03_0000.xml", + "product_code":"config", + "code":"7", + "des":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ", + "doc_type":"api", + "kw":"Calling APIs,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Calling APIs", + "githuburl":"" + }, + { + "uri":"rms_04_0000.html", + "node_id":"rms_04_0000.xml", + "product_code":"config", + "code":"8", + "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":"APIs", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"APIs", + "githuburl":"" + }, + { + "uri":"rms_04_0100.html", + "node_id":"rms_04_0100.xml", + "product_code":"config", + "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":"Resource Query", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Resource Query", + "githuburl":"" + }, + { + "uri":"rms_04_0101.html", + "node_id":"rms_04_0101.xml", + "product_code":"config", + "code":"10", + "des":"This API is used to query specified resources.To call this API, you must have the rms:resources:list permission. For example,if you need to query the ecs.cloudservers res", + "doc_type":"api", + "kw":"Querying Resources of a Specific Type,Resource Query,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying Resources of a Specific Type", + "githuburl":"" + }, + { + "uri":"rms_04_0102.html", + "node_id":"rms_04_0102.xml", + "product_code":"config", + "code":"11", + "des":"Querying cloud services, resources, and regionsFor details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/providersStatus code: 200Status code: 500NoneSta", + "doc_type":"api", + "kw":"Listing Cloud Services,Resource Query,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Listing Cloud Services", + "githuburl":"" + }, + { + "uri":"rms_04_0103.html", + "node_id":"rms_04_0103.xml", + "product_code":"config", + "code":"12", + "des":"This API is used to query details of a resource based on its ID. You must have the rms:resources:get permission. For example, to query ECSs whose resource type is ecs.clo", + "doc_type":"api", + "kw":"Querying a Resource,Resource Query,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying a Resource", + "githuburl":"" + }, + { + "uri":"rms_04_0109.html", + "node_id":"rms_04_0109.xml", + "product_code":"config", + "code":"13", + "des":"Querying all resources recorded by the resource recorder. To call this API, you must have the rms:resources:list permission.For details, see Calling APIs.GET /v1/resource", + "doc_type":"api", + "kw":"Listing Resources Recorded by the Resource Recorder,Resource Query,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Listing Resources Recorded by the Resource Recorder", + "githuburl":"" + }, + { + "uri":"rms_04_0110.html", + "node_id":"rms_04_0110.xml", + "product_code":"config", + "code":"14", + "des":"Querying how many resources are recorded by the resource recorder in the current accountFor details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/tracked", + "doc_type":"api", + "kw":"Querying how many resources are recorded by the resource recorder,Resource Query,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying how many resources are recorded by the resource recorder", + "githuburl":"" + }, + { + "uri":"rms_04_0111.html", + "node_id":"rms_04_0111.xml", + "product_code":"config", + "code":"15", + "des":"Querying resource tags recorded by the resource recorder in the current accountFor details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/tracked-resource", + "doc_type":"api", + "kw":"Querying resource tags recorded by the resource recorder,Resource Query,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying resource tags recorded by the resource recorder", + "githuburl":"" + }, + { + "uri":"rms_04_0112.html", + "node_id":"rms_04_0112.xml", + "product_code":"config", + "code":"16", + "des":"Querying resource overview recorded by the resource recorder in the current accountFor details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/tracked-reso", + "doc_type":"api", + "kw":"Querying resource overview recorded by the resource recorder,Resource Query,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying resource overview recorded by the resource recorder", + "githuburl":"" + }, + { + "uri":"rms_04_0113.html", + "node_id":"rms_04_0113.xml", + "product_code":"config", + "code":"17", + "des":"Querying a specific resource recorded by the resource recorder in the current accountFor details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/tracked-r", + "doc_type":"api", + "kw":"Querying a specific resource recorded by the resource recorder,Resource Query,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying a specific resource recorded by the resource recorder", + "githuburl":"" + }, + { + "uri":"rms_04_0104.html", + "node_id":"rms_04_0104.xml", + "product_code":"config", + "code":"18", + "des":"This API is used to query all resources under your account and you must have the **rms:resources:list **permission.For details, see Calling APIs.GET /v1/resource-manager/", + "doc_type":"api", + "kw":"Querying All Resources Under Your Account,Resource Query,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying All Resources Under Your Account", + "githuburl":"" + }, + { + "uri":"rms_04_0105.html", + "node_id":"rms_04_0105.xml", + "product_code":"config", + "code":"19", + "des":"This API is used to query a resource under your account.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/all-resources/{resource_id}Status code:", + "doc_type":"api", + "kw":"Querying a Resource Under Your Account,Resource Query,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying a Resource Under Your Account", + "githuburl":"" + }, + { + "uri":"rms_04_0106.html", + "node_id":"rms_04_0106.xml", + "product_code":"config", + "code":"20", + "des":"This API is used to query all resource tags under your account.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/all-resources/tagsStatus code: 2", + "doc_type":"api", + "kw":"Querying Resource Tags,Resource Query,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying Resource Tags", + "githuburl":"" + }, + { + "uri":"rms_04_0107.html", + "node_id":"rms_04_0107.xml", + "product_code":"config", + "code":"21", + "des":"This API is used to query the number of resources.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/all-resources/countStatus code: 200Status cod", + "doc_type":"api", + "kw":"Querying the Number of Resources,Resource Query,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying the Number of Resources", + "githuburl":"" + }, + { + "uri":"rms_04_0108.html", + "node_id":"rms_04_0108.xml", + "product_code":"config", + "code":"22", + "des":"This API is used to query a resource summary.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/all-resources/summaryStatus code: 200Status code: ", + "doc_type":"api", + "kw":"Querying a Resource Summary,Resource Query,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying a Resource Summary", + "githuburl":"" + }, + { + "uri":"rms_04_0200.html", + "node_id":"rms_04_0200.xml", + "product_code":"config", + "code":"23", + "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":"Resource Recorder", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Resource Recorder", + "githuburl":"" + }, + { + "uri":"rms_04_0201.html", + "node_id":"rms_04_0201.xml", + "product_code":"config", + "code":"24", + "des":"This API is used to query details about the resource recorder.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/tracker-configStatus code: 200Sta", + "doc_type":"api", + "kw":"Querying the Resource Recorder,Resource Recorder,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying the Resource Recorder", + "githuburl":"" + }, + { + "uri":"rms_04_0202.html", + "node_id":"rms_04_0202.xml", + "product_code":"config", + "code":"25", + "des":"This API is used to delete the resource recorder.For details, see Calling APIs.DELETE /v1/resource-manager/domains/{domain_id}/tracker-configStatus code: 400Status code: ", + "doc_type":"api", + "kw":"Deleting the Resource Recorder,Resource Recorder,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Deleting the Resource Recorder", + "githuburl":"" + }, + { + "uri":"rms_04_0203.html", + "node_id":"rms_04_0203.xml", + "product_code":"config", + "code":"26", + "des":"This API is used to create or modify the resource recorder. Only one resource recorder can be configured.For details, see Calling APIs.PUT /v1/resource-manager/domains/{d", + "doc_type":"api", + "kw":"Creating or Modifying the Resource Recorder,Resource Recorder,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Creating or Modifying the Resource Recorder", + "githuburl":"" + }, + { + "uri":"rms_04_0300.html", + "node_id":"rms_04_0300.xml", + "product_code":"config", + "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":"Resource Relationships", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Resource Relationships", + "githuburl":"" + }, + { + "uri":"rms_04_0302.html", + "node_id":"rms_04_0302.xml", + "product_code":"config", + "code":"28", + "des":"This API is used to query the relationship between a resource and other resources by the resource ID. The relationship direction can be in or out. An IAM user needs to ha", + "doc_type":"api", + "kw":"Querying Details About Resource Relationships,Resource Relationships,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying Details About Resource Relationships", + "githuburl":"" + }, + { + "uri":"rms_04_0400.html", + "node_id":"rms_04_0400.xml", + "product_code":"config", + "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":"Resource Change Records", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Resource Change Records", + "githuburl":"" + }, + { + "uri":"rms_04_0401.html", + "node_id":"rms_04_0401.xml", + "product_code":"config", + "code":"30", + "des":"This API is used to query change records of a resource and its relationships with other resources.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_i", + "doc_type":"api", + "kw":"Querying Change Records of a Resource,Resource Change Records,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying Change Records of a Resource", + "githuburl":"" + }, + { + "uri":"rms_04_0500.html", + "node_id":"rms_04_0500.xml", + "product_code":"config", + "code":"31", + "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":"Compliance", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Compliance", + "githuburl":"" + }, + { + "uri":"rms_04_0501.html", + "node_id":"rms_04_0501.xml", + "product_code":"config", + "code":"32", + "des":"This API is used to query all built-in policies.For details, see Calling APIs.GET /v1/resource-manager/policy-definitionsStatus code: 200Status code: 400Status code: 403S", + "doc_type":"api", + "kw":"Querying All Built-in Policies,Compliance,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying All Built-in Policies", + "githuburl":"" + }, + { + "uri":"rms_04_0502.html", + "node_id":"rms_04_0502.xml", + "product_code":"config", + "code":"33", + "des":"This API is used to query a built-in policy based on the policy ID.For details, see Calling APIs.GET /v1/resource-manager/policy-definitions/{policy_definition_id}Status ", + "doc_type":"api", + "kw":"Querying a Built-in Policy,Compliance,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying a Built-in Policy", + "githuburl":"" + }, + { + "uri":"rms_04_0503.html", + "node_id":"rms_04_0503.xml", + "product_code":"config", + "code":"34", + "des":"This API is used to add a rule.For details, see Calling APIs.PUT /v1/resource-manager/domains/{domain_id}/policy-assignmentsStatus code: 200Status code: 400Status code: 4", + "doc_type":"api", + "kw":"Adding a Rule,Compliance,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Adding a Rule", + "githuburl":"" + }, + { + "uri":"rms_04_0504.html", + "node_id":"rms_04_0504.xml", + "product_code":"config", + "code":"35", + "des":"This API is used to query all rules.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/policy-assignmentsStatus code: 200Status code: 400Status co", + "doc_type":"api", + "kw":"Querying All Rules,Compliance,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying All Rules", + "githuburl":"" + }, + { + "uri":"rms_04_0505.html", + "node_id":"rms_04_0505.xml", + "product_code":"config", + "code":"36", + "des":"This API is used to modify a rule.For details, see Calling APIs.PUT /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}Status code: 200Stat", + "doc_type":"api", + "kw":"Modifying a Rule,Compliance,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Modifying a Rule", + "githuburl":"" + }, + { + "uri":"rms_04_0506.html", + "node_id":"rms_04_0506.xml", + "product_code":"config", + "code":"37", + "des":"This API is used to query a rule based on the rule ID.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}", + "doc_type":"api", + "kw":"Querying a Rule,Compliance,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying a Rule", + "githuburl":"" + }, + { + "uri":"rms_04_0507.html", + "node_id":"rms_04_0507.xml", + "product_code":"config", + "code":"38", + "des":"This API is used to delete a rule based on the rule ID. Only rules in the disabled state can be deleted.For details, see Calling APIs.DELETE /v1/resource-manager/domains/", + "doc_type":"api", + "kw":"Deleting a Rule,Compliance,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Deleting a Rule", + "githuburl":"" + }, + { + "uri":"rms_04_0508.html", + "node_id":"rms_04_0508.xml", + "product_code":"config", + "code":"39", + "des":"This API is used to enable a rule based on the rule ID.For details, see Calling APIs.POST /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_i", + "doc_type":"api", + "kw":"Enabling a Rule,Compliance,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Enabling a Rule", + "githuburl":"" + }, + { + "uri":"rms_04_0509.html", + "node_id":"rms_04_0509.xml", + "product_code":"config", + "code":"40", + "des":"This API is used to disable a rule based on the rule ID.For details, see Calling APIs.POST /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_", + "doc_type":"api", + "kw":"Disabling a Rule,Compliance,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Disabling a Rule", + "githuburl":"" + }, + { + "uri":"rms_04_0510.html", + "node_id":"rms_04_0510.xml", + "product_code":"config", + "code":"41", + "des":"This API is used to trigger a rule manually by rule ID to evaluate resources.For details, see Calling APIs.POST /v1/resource-manager/domains/{domain_id}/policy-assignment", + "doc_type":"api", + "kw":"Running a Resource Compliance Evaluation,Compliance,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Running a Resource Compliance Evaluation", + "githuburl":"" + }, + { + "uri":"rms_04_0511.html", + "node_id":"rms_04_0511.xml", + "product_code":"config", + "code":"42", + "des":"This API is used to query the evaluation status of a rule by rule ID.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy", + "doc_type":"api", + "kw":"Querying the Evaluation Status of a Rule,Compliance,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying the Evaluation Status of a Rule", + "githuburl":"" + }, + { + "uri":"rms_04_0512.html", + "node_id":"rms_04_0512.xml", + "product_code":"config", + "code":"43", + "des":"This API is used to query all compliance results of a resource evaluated by rules. The resource is searched by resource ID.For details, see Calling APIs.GET /v1/resource-", + "doc_type":"api", + "kw":"Querying the Compliance Results of a Resource,Compliance,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying the Compliance Results of a Resource", + "githuburl":"" + }, + { + "uri":"rms_04_0513.html", + "node_id":"rms_04_0513.xml", + "product_code":"config", + "code":"44", + "des":"This API is used to query all compliance results of resources evaluated by a rule. The rule is searched by rule ID.For details, see Calling APIs.GET /v1/resource-manager/", + "doc_type":"api", + "kw":"Querying All Compliance Results of Resources Evaluated by a Rule,Compliance,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying All Compliance Results of Resources Evaluated by a Rule", + "githuburl":"" + }, + { + "uri":"rms_04_0514.html", + "node_id":"rms_04_0514.xml", + "product_code":"config", + "code":"45", + "des":"This API is used to query all compliance results of resources under a user.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/policy-statesStatus ", + "doc_type":"api", + "kw":"Querying All Compliance Results of Resources Under a User,Compliance,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying All Compliance Results of Resources Under a User", + "githuburl":"" + }, + { + "uri":"rms_04_0515.html", + "node_id":"rms_04_0515.xml", + "product_code":"config", + "code":"46", + "des":"This API is used to update the compliance result of a custom rule.For details, see Calling APIs.PUT /v1/resource-manager/domains/{domain_id}/policy-statesStatus code: 200", + "doc_type":"api", + "kw":"Updating the Compliance Result,Compliance,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Updating the Compliance Result", + "githuburl":"" + }, + { + "uri":"rms_04_0600.html", + "node_id":"rms_04_0600.xml", + "product_code":"config", + "code":"47", + "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":"Region Management", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Region Management", + "githuburl":"" + }, + { + "uri":"rms_04_0601.html", + "node_id":"rms_04_0601.xml", + "product_code":"config", + "code":"48", + "des":"This API is used to query regions visible to you.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/regionsStatus code: 200Status code: 400Status ", + "doc_type":"api", + "kw":"Querying Regions Visible to You,Region Management,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying Regions Visible to You", + "githuburl":"" + }, + { + "uri":"rms_04_0700.html", + "node_id":"rms_04_0700.xml", + "product_code":"config", + "code":"49", + "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":"Advanced Queries", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Advanced Queries", + "githuburl":"" + }, + { + "uri":"rms_04_0701.html", + "node_id":"rms_04_0701.xml", + "product_code":"config", + "code":"50", + "des":"This API is used to run advanced queries.For details, see Calling APIs.POST /v1/resource-manager/domains/{domain_id}/run-queryStatus code: 200Status code: 400Status code:", + "doc_type":"api", + "kw":"Running Advanced Queries,Advanced Queries,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Running Advanced Queries", + "githuburl":"" + }, + { + "uri":"rms_04_0702.html", + "node_id":"rms_04_0702.xml", + "product_code":"config", + "code":"51", + "des":"This API is used to create an advanced query.For details, see Calling APIs.POST /v1/resource-manager/domains/{domain_id}/stored-queriesStatus code: 200Status code: 400Sta", + "doc_type":"api", + "kw":"Creating an Advanced Query,Advanced Queries,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Creating an Advanced Query", + "githuburl":"" + }, + { + "uri":"rms_04_0703.html", + "node_id":"rms_04_0703.xml", + "product_code":"config", + "code":"52", + "des":"This API is used to list all advanced queries.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/stored-queriesStatus code: 200Status code: 400Sta", + "doc_type":"api", + "kw":"Listing Advanced Queries,Advanced Queries,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Listing Advanced Queries", + "githuburl":"" + }, + { + "uri":"rms_04_0704.html", + "node_id":"rms_04_0704.xml", + "product_code":"config", + "code":"53", + "des":"This API is used to query an advanced query.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/stored-queries/{query_id}Status code: 200Status cod", + "doc_type":"api", + "kw":"Querying an Advanced Query,Advanced Queries,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying an Advanced Query", + "githuburl":"" + }, + { + "uri":"rms_04_0705.html", + "node_id":"rms_04_0705.xml", + "product_code":"config", + "code":"54", + "des":"This API is used to update a custom query.For details, see Calling APIs.PUT /v1/resource-manager/domains/{domain_id}/stored-queries/{query_id}Status code: 200Status code:", + "doc_type":"api", + "kw":"Updating an Advanced Query,Advanced Queries,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Updating an Advanced Query", + "githuburl":"" + }, + { + "uri":"rms_04_0706.html", + "node_id":"rms_04_0706.xml", + "product_code":"config", + "code":"55", + "des":"This API is used to delete an advanced query.For details, see Calling APIs.DELETE /v1/resource-manager/domains/{domain_id}/stored-queries/{query_id}Status code: 400Status", + "doc_type":"api", + "kw":"Deleting an Advanced Query,Advanced Queries,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Deleting an Advanced Query", + "githuburl":"" + }, + { + "uri":"rms_04_0707.html", + "node_id":"rms_04_0707.xml", + "product_code":"config", + "code":"56", + "des":"This API is used to query schemas used by advanced queries.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/schemasStatus code: 200Status code: ", + "doc_type":"api", + "kw":"Querying Schemas,Advanced Queries,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Querying Schemas", + "githuburl":"" + }, + { + "uri":"rms_05_0000.html", + "node_id":"rms_05_0000.xml", + "product_code":"config", + "code":"57", + "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":"Permissions Policies and Supported Actions", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Permissions Policies and Supported Actions", + "githuburl":"" + }, + { + "uri":"rms_05_0100.html", + "node_id":"rms_05_0100.xml", + "product_code":"config", + "code":"58", + "des":"This chapter describes how to use IAM to implement fine-grained permissions control for your Config resources. If your account does not need individual IAM users, skip th", + "doc_type":"api", + "kw":"Permissions Policies and Supported Actions,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Permissions Policies and Supported Actions", + "githuburl":"" + }, + { + "uri":"rms_05_0200.html", + "node_id":"rms_05_0200.xml", + "product_code":"config", + "code":"59", + "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":"Resource Query,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Resource Query", + "githuburl":"" + }, + { + "uri":"rms_05_0300.html", + "node_id":"rms_05_0300.xml", + "product_code":"config", + "code":"60", + "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":"Resource Recorder,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Resource Recorder", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000001991150822.html", + "node_id":"en-us_topic_0000001991150822.xml", + "product_code":"config", + "code":"61", + "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":"Resource Relationships,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Resource Relationships", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002027710481.html", + "node_id":"en-us_topic_0000002027710481.xml", + "product_code":"config", + "code":"62", + "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":"Resource Change Records,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Resource Change Records", + "githuburl":"" + }, + { + "uri":"rms_05_0400.html", + "node_id":"rms_05_0400.xml", + "product_code":"config", + "code":"63", + "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":"Compliance,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Compliance", + "githuburl":"" + }, + { + "uri":"en-us_topic_0000002027750033.html", + "node_id":"en-us_topic_0000002027750033.xml", + "product_code":"config", + "code":"64", + "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":"Region Management,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Region Management", + "githuburl":"" + }, + { + "uri":"rms_05_0500.html", + "node_id":"rms_05_0500.xml", + "product_code":"config", + "code":"65", + "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":"Advanced Queries,Permissions Policies and Supported Actions,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Advanced Queries", + "githuburl":"" + }, + { + "uri":"rms_06_0000.html", + "node_id":"rms_06_0000.xml", + "product_code":"config", + "code":"66", + "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":"Appendixes", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Appendixes", + "githuburl":"" + }, + { + "uri":"ErrorCode.html", + "node_id":"errorcode.xml", + "product_code":"config", + "code":"67", + "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,Appendixes,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Error Codes", + "githuburl":"" + }, + { + "uri":"rms_06_0100.html", + "node_id":"rms_06_0100.xml", + "product_code":"config", + "code":"68", + "des":"You can obtain the cloud services (provider) and resource types (type) supported by Config in either of the following ways:Calling APIsYou can call the API for listing cl", + "doc_type":"api", + "kw":"Supported Services and Resource Types,Appendixes,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Supported Services and Resource Types", + "githuburl":"" + }, + { + "uri":"rms_02_0019.html", + "node_id":"rms_02_0019.xml", + "product_code":"config", + "code":"69", + "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":"Supported Resources,Appendixes,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Supported Resources", + "githuburl":"" + }, + { + "uri":"rms_07_0200.html", + "node_id":"rms_07_0200.xml", + "product_code":"config", + "code":"70", + "des":"NormalReturned ValueDescription200 OKThe results of GET and PUT operations are returned as expected.201 CreatedThe results of the POST operation are returned as expected.", + "doc_type":"api", + "kw":"Status Codes,Appendixes,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Status Codes", + "githuburl":"" + }, + { + "uri":"rms_08_0000.html", + "node_id":"rms_08_0000.xml", + "product_code":"config", + "code":"71", + "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":"Change History,API Reference", + "search_title":"", + "metedata":[ + { + "documenttype":"api", + "prodname":"config" + } + ], + "title":"Change History", + "githuburl":"" + } +] \ No newline at end of file diff --git a/docs/config/api-ref/CLASS.TXT.json b/docs/config/api-ref/CLASS.TXT.json new file mode 100644 index 00000000..b16eb1f3 --- /dev/null +++ b/docs/config/api-ref/CLASS.TXT.json @@ -0,0 +1,641 @@ +[ + { + "desc":"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.", + "product_code":"config", + "title":"Before You Start", + "uri":"rms_01_0000.html", + "doc_type":"api", + "p_code":"", + "code":"1" + }, + { + "desc":"With Config, you can search for, record, and continuously evaluate your resource configuration to make sure that your expectations are met.This document describes the Con", + "product_code":"config", + "title":"Introduction", + "uri":"rms_01_0100.html", + "doc_type":"api", + "p_code":"1", + "code":"2" + }, + { + "desc":"Config supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.", + "product_code":"config", + "title":"API Calling", + "uri":"rms_01_0200.html", + "doc_type":"api", + "p_code":"1", + "code":"3" + }, + { + "desc":"AccountAn account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account ", + "product_code":"config", + "title":"Concepts", + "uri":"rms_01_0500.html", + "doc_type":"api", + "p_code":"1", + "code":"4" + }, + { + "desc":"Some Config APIs support pagination query if you add limit and marker to the request URL. The value of marker must be the same as that returned in the last pagination que", + "product_code":"config", + "title":"Querying Data by Page", + "uri":"rms_01_0600.html", + "doc_type":"api", + "p_code":"1", + "code":"5" + }, + { + "desc":"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.", + "product_code":"config", + "title":"API Overview", + "uri":"rms_02_0000.html", + "doc_type":"api", + "p_code":"", + "code":"6" + }, + { + "desc":"Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform ", + "product_code":"config", + "title":"Calling APIs", + "uri":"rms_03_0000.html", + "doc_type":"api", + "p_code":"", + "code":"7" + }, + { + "desc":"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.", + "product_code":"config", + "title":"APIs", + "uri":"rms_04_0000.html", + "doc_type":"api", + "p_code":"", + "code":"8" + }, + { + "desc":"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.", + "product_code":"config", + "title":"Resource Query", + "uri":"rms_04_0100.html", + "doc_type":"api", + "p_code":"8", + "code":"9" + }, + { + "desc":"This API is used to query specified resources.To call this API, you must have the rms:resources:list permission. For example,if you need to query the ecs.cloudservers res", + "product_code":"config", + "title":"Querying Resources of a Specific Type", + "uri":"rms_04_0101.html", + "doc_type":"api", + "p_code":"9", + "code":"10" + }, + { + "desc":"Querying cloud services, resources, and regionsFor details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/providersStatus code: 200Status code: 500NoneSta", + "product_code":"config", + "title":"Listing Cloud Services", + "uri":"rms_04_0102.html", + "doc_type":"api", + "p_code":"9", + "code":"11" + }, + { + "desc":"This API is used to query details of a resource based on its ID. You must have the rms:resources:get permission. For example, to query ECSs whose resource type is ecs.clo", + "product_code":"config", + "title":"Querying a Resource", + "uri":"rms_04_0103.html", + "doc_type":"api", + "p_code":"9", + "code":"12" + }, + { + "desc":"Querying all resources recorded by the resource recorder. To call this API, you must have the rms:resources:list permission.For details, see Calling APIs.GET /v1/resource", + "product_code":"config", + "title":"Listing Resources Recorded by the Resource Recorder", + "uri":"rms_04_0109.html", + "doc_type":"api", + "p_code":"9", + "code":"13" + }, + { + "desc":"Querying how many resources are recorded by the resource recorder in the current accountFor details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/tracked", + "product_code":"config", + "title":"Querying how many resources are recorded by the resource recorder", + "uri":"rms_04_0110.html", + "doc_type":"api", + "p_code":"9", + "code":"14" + }, + { + "desc":"Querying resource tags recorded by the resource recorder in the current accountFor details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/tracked-resource", + "product_code":"config", + "title":"Querying resource tags recorded by the resource recorder", + "uri":"rms_04_0111.html", + "doc_type":"api", + "p_code":"9", + "code":"15" + }, + { + "desc":"Querying resource overview recorded by the resource recorder in the current accountFor details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/tracked-reso", + "product_code":"config", + "title":"Querying resource overview recorded by the resource recorder", + "uri":"rms_04_0112.html", + "doc_type":"api", + "p_code":"9", + "code":"16" + }, + { + "desc":"Querying a specific resource recorded by the resource recorder in the current accountFor details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/tracked-r", + "product_code":"config", + "title":"Querying a specific resource recorded by the resource recorder", + "uri":"rms_04_0113.html", + "doc_type":"api", + "p_code":"9", + "code":"17" + }, + { + "desc":"This API is used to query all resources under your account and you must have the **rms:resources:list **permission.For details, see Calling APIs.GET /v1/resource-manager/", + "product_code":"config", + "title":"Querying All Resources Under Your Account", + "uri":"rms_04_0104.html", + "doc_type":"api", + "p_code":"9", + "code":"18" + }, + { + "desc":"This API is used to query a resource under your account.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/all-resources/{resource_id}Status code:", + "product_code":"config", + "title":"Querying a Resource Under Your Account", + "uri":"rms_04_0105.html", + "doc_type":"api", + "p_code":"9", + "code":"19" + }, + { + "desc":"This API is used to query all resource tags under your account.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/all-resources/tagsStatus code: 2", + "product_code":"config", + "title":"Querying Resource Tags", + "uri":"rms_04_0106.html", + "doc_type":"api", + "p_code":"9", + "code":"20" + }, + { + "desc":"This API is used to query the number of resources.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/all-resources/countStatus code: 200Status cod", + "product_code":"config", + "title":"Querying the Number of Resources", + "uri":"rms_04_0107.html", + "doc_type":"api", + "p_code":"9", + "code":"21" + }, + { + "desc":"This API is used to query a resource summary.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/all-resources/summaryStatus code: 200Status code: ", + "product_code":"config", + "title":"Querying a Resource Summary", + "uri":"rms_04_0108.html", + "doc_type":"api", + "p_code":"9", + "code":"22" + }, + { + "desc":"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.", + "product_code":"config", + "title":"Resource Recorder", + "uri":"rms_04_0200.html", + "doc_type":"api", + "p_code":"8", + "code":"23" + }, + { + "desc":"This API is used to query details about the resource recorder.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/tracker-configStatus code: 200Sta", + "product_code":"config", + "title":"Querying the Resource Recorder", + "uri":"rms_04_0201.html", + "doc_type":"api", + "p_code":"23", + "code":"24" + }, + { + "desc":"This API is used to delete the resource recorder.For details, see Calling APIs.DELETE /v1/resource-manager/domains/{domain_id}/tracker-configStatus code: 400Status code: ", + "product_code":"config", + "title":"Deleting the Resource Recorder", + "uri":"rms_04_0202.html", + "doc_type":"api", + "p_code":"23", + "code":"25" + }, + { + "desc":"This API is used to create or modify the resource recorder. Only one resource recorder can be configured.For details, see Calling APIs.PUT /v1/resource-manager/domains/{d", + "product_code":"config", + "title":"Creating or Modifying the Resource Recorder", + "uri":"rms_04_0203.html", + "doc_type":"api", + "p_code":"23", + "code":"26" + }, + { + "desc":"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.", + "product_code":"config", + "title":"Resource Relationships", + "uri":"rms_04_0300.html", + "doc_type":"api", + "p_code":"8", + "code":"27" + }, + { + "desc":"This API is used to query the relationship between a resource and other resources by the resource ID. The relationship direction can be in or out. An IAM user needs to ha", + "product_code":"config", + "title":"Querying Details About Resource Relationships", + "uri":"rms_04_0302.html", + "doc_type":"api", + "p_code":"27", + "code":"28" + }, + { + "desc":"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.", + "product_code":"config", + "title":"Resource Change Records", + "uri":"rms_04_0400.html", + "doc_type":"api", + "p_code":"8", + "code":"29" + }, + { + "desc":"This API is used to query change records of a resource and its relationships with other resources.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_i", + "product_code":"config", + "title":"Querying Change Records of a Resource", + "uri":"rms_04_0401.html", + "doc_type":"api", + "p_code":"29", + "code":"30" + }, + { + "desc":"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.", + "product_code":"config", + "title":"Compliance", + "uri":"rms_04_0500.html", + "doc_type":"api", + "p_code":"8", + "code":"31" + }, + { + "desc":"This API is used to query all built-in policies.For details, see Calling APIs.GET /v1/resource-manager/policy-definitionsStatus code: 200Status code: 400Status code: 403S", + "product_code":"config", + "title":"Querying All Built-in Policies", + "uri":"rms_04_0501.html", + "doc_type":"api", + "p_code":"31", + "code":"32" + }, + { + "desc":"This API is used to query a built-in policy based on the policy ID.For details, see Calling APIs.GET /v1/resource-manager/policy-definitions/{policy_definition_id}Status ", + "product_code":"config", + "title":"Querying a Built-in Policy", + "uri":"rms_04_0502.html", + "doc_type":"api", + "p_code":"31", + "code":"33" + }, + { + "desc":"This API is used to add a rule.For details, see Calling APIs.PUT /v1/resource-manager/domains/{domain_id}/policy-assignmentsStatus code: 200Status code: 400Status code: 4", + "product_code":"config", + "title":"Adding a Rule", + "uri":"rms_04_0503.html", + "doc_type":"api", + "p_code":"31", + "code":"34" + }, + { + "desc":"This API is used to query all rules.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/policy-assignmentsStatus code: 200Status code: 400Status co", + "product_code":"config", + "title":"Querying All Rules", + "uri":"rms_04_0504.html", + "doc_type":"api", + "p_code":"31", + "code":"35" + }, + { + "desc":"This API is used to modify a rule.For details, see Calling APIs.PUT /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}Status code: 200Stat", + "product_code":"config", + "title":"Modifying a Rule", + "uri":"rms_04_0505.html", + "doc_type":"api", + "p_code":"31", + "code":"36" + }, + { + "desc":"This API is used to query a rule based on the rule ID.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}", + "product_code":"config", + "title":"Querying a Rule", + "uri":"rms_04_0506.html", + "doc_type":"api", + "p_code":"31", + "code":"37" + }, + { + "desc":"This API is used to delete a rule based on the rule ID. Only rules in the disabled state can be deleted.For details, see Calling APIs.DELETE /v1/resource-manager/domains/", + "product_code":"config", + "title":"Deleting a Rule", + "uri":"rms_04_0507.html", + "doc_type":"api", + "p_code":"31", + "code":"38" + }, + { + "desc":"This API is used to enable a rule based on the rule ID.For details, see Calling APIs.POST /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_i", + "product_code":"config", + "title":"Enabling a Rule", + "uri":"rms_04_0508.html", + "doc_type":"api", + "p_code":"31", + "code":"39" + }, + { + "desc":"This API is used to disable a rule based on the rule ID.For details, see Calling APIs.POST /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_", + "product_code":"config", + "title":"Disabling a Rule", + "uri":"rms_04_0509.html", + "doc_type":"api", + "p_code":"31", + "code":"40" + }, + { + "desc":"This API is used to trigger a rule manually by rule ID to evaluate resources.For details, see Calling APIs.POST /v1/resource-manager/domains/{domain_id}/policy-assignment", + "product_code":"config", + "title":"Running a Resource Compliance Evaluation", + "uri":"rms_04_0510.html", + "doc_type":"api", + "p_code":"31", + "code":"41" + }, + { + "desc":"This API is used to query the evaluation status of a rule by rule ID.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy", + "product_code":"config", + "title":"Querying the Evaluation Status of a Rule", + "uri":"rms_04_0511.html", + "doc_type":"api", + "p_code":"31", + "code":"42" + }, + { + "desc":"This API is used to query all compliance results of a resource evaluated by rules. The resource is searched by resource ID.For details, see Calling APIs.GET /v1/resource-", + "product_code":"config", + "title":"Querying the Compliance Results of a Resource", + "uri":"rms_04_0512.html", + "doc_type":"api", + "p_code":"31", + "code":"43" + }, + { + "desc":"This API is used to query all compliance results of resources evaluated by a rule. The rule is searched by rule ID.For details, see Calling APIs.GET /v1/resource-manager/", + "product_code":"config", + "title":"Querying All Compliance Results of Resources Evaluated by a Rule", + "uri":"rms_04_0513.html", + "doc_type":"api", + "p_code":"31", + "code":"44" + }, + { + "desc":"This API is used to query all compliance results of resources under a user.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/policy-statesStatus ", + "product_code":"config", + "title":"Querying All Compliance Results of Resources Under a User", + "uri":"rms_04_0514.html", + "doc_type":"api", + "p_code":"31", + "code":"45" + }, + { + "desc":"This API is used to update the compliance result of a custom rule.For details, see Calling APIs.PUT /v1/resource-manager/domains/{domain_id}/policy-statesStatus code: 200", + "product_code":"config", + "title":"Updating the Compliance Result", + "uri":"rms_04_0515.html", + "doc_type":"api", + "p_code":"31", + "code":"46" + }, + { + "desc":"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.", + "product_code":"config", + "title":"Region Management", + "uri":"rms_04_0600.html", + "doc_type":"api", + "p_code":"8", + "code":"47" + }, + { + "desc":"This API is used to query regions visible to you.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/regionsStatus code: 200Status code: 400Status ", + "product_code":"config", + "title":"Querying Regions Visible to You", + "uri":"rms_04_0601.html", + "doc_type":"api", + "p_code":"47", + "code":"48" + }, + { + "desc":"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.", + "product_code":"config", + "title":"Advanced Queries", + "uri":"rms_04_0700.html", + "doc_type":"api", + "p_code":"8", + "code":"49" + }, + { + "desc":"This API is used to run advanced queries.For details, see Calling APIs.POST /v1/resource-manager/domains/{domain_id}/run-queryStatus code: 200Status code: 400Status code:", + "product_code":"config", + "title":"Running Advanced Queries", + "uri":"rms_04_0701.html", + "doc_type":"api", + "p_code":"49", + "code":"50" + }, + { + "desc":"This API is used to create an advanced query.For details, see Calling APIs.POST /v1/resource-manager/domains/{domain_id}/stored-queriesStatus code: 200Status code: 400Sta", + "product_code":"config", + "title":"Creating an Advanced Query", + "uri":"rms_04_0702.html", + "doc_type":"api", + "p_code":"49", + "code":"51" + }, + { + "desc":"This API is used to list all advanced queries.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/stored-queriesStatus code: 200Status code: 400Sta", + "product_code":"config", + "title":"Listing Advanced Queries", + "uri":"rms_04_0703.html", + "doc_type":"api", + "p_code":"49", + "code":"52" + }, + { + "desc":"This API is used to query an advanced query.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/stored-queries/{query_id}Status code: 200Status cod", + "product_code":"config", + "title":"Querying an Advanced Query", + "uri":"rms_04_0704.html", + "doc_type":"api", + "p_code":"49", + "code":"53" + }, + { + "desc":"This API is used to update a custom query.For details, see Calling APIs.PUT /v1/resource-manager/domains/{domain_id}/stored-queries/{query_id}Status code: 200Status code:", + "product_code":"config", + "title":"Updating an Advanced Query", + "uri":"rms_04_0705.html", + "doc_type":"api", + "p_code":"49", + "code":"54" + }, + { + "desc":"This API is used to delete an advanced query.For details, see Calling APIs.DELETE /v1/resource-manager/domains/{domain_id}/stored-queries/{query_id}Status code: 400Status", + "product_code":"config", + "title":"Deleting an Advanced Query", + "uri":"rms_04_0706.html", + "doc_type":"api", + "p_code":"49", + "code":"55" + }, + { + "desc":"This API is used to query schemas used by advanced queries.For details, see Calling APIs.GET /v1/resource-manager/domains/{domain_id}/schemasStatus code: 200Status code: ", + "product_code":"config", + "title":"Querying Schemas", + "uri":"rms_04_0707.html", + "doc_type":"api", + "p_code":"49", + "code":"56" + }, + { + "desc":"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.", + "product_code":"config", + "title":"Permissions Policies and Supported Actions", + "uri":"rms_05_0000.html", + "doc_type":"api", + "p_code":"", + "code":"57" + }, + { + "desc":"This chapter describes how to use IAM to implement fine-grained permissions control for your Config resources. If your account does not need individual IAM users, skip th", + "product_code":"config", + "title":"Permissions Policies and Supported Actions", + "uri":"rms_05_0100.html", + "doc_type":"api", + "p_code":"57", + "code":"58" + }, + { + "desc":"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.", + "product_code":"config", + "title":"Resource Query", + "uri":"rms_05_0200.html", + "doc_type":"api", + "p_code":"57", + "code":"59" + }, + { + "desc":"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.", + "product_code":"config", + "title":"Resource Recorder", + "uri":"rms_05_0300.html", + "doc_type":"api", + "p_code":"57", + "code":"60" + }, + { + "desc":"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.", + "product_code":"config", + "title":"Resource Relationships", + "uri":"en-us_topic_0000001991150822.html", + "doc_type":"api", + "p_code":"57", + "code":"61" + }, + { + "desc":"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.", + "product_code":"config", + "title":"Resource Change Records", + "uri":"en-us_topic_0000002027710481.html", + "doc_type":"api", + "p_code":"57", + "code":"62" + }, + { + "desc":"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.", + "product_code":"config", + "title":"Compliance", + "uri":"rms_05_0400.html", + "doc_type":"api", + "p_code":"57", + "code":"63" + }, + { + "desc":"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.", + "product_code":"config", + "title":"Region Management", + "uri":"en-us_topic_0000002027750033.html", + "doc_type":"api", + "p_code":"57", + "code":"64" + }, + { + "desc":"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.", + "product_code":"config", + "title":"Advanced Queries", + "uri":"rms_05_0500.html", + "doc_type":"api", + "p_code":"57", + "code":"65" + }, + { + "desc":"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.", + "product_code":"config", + "title":"Appendixes", + "uri":"rms_06_0000.html", + "doc_type":"api", + "p_code":"", + "code":"66" + }, + { + "desc":"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.", + "product_code":"config", + "title":"Error Codes", + "uri":"ErrorCode.html", + "doc_type":"api", + "p_code":"66", + "code":"67" + }, + { + "desc":"You can obtain the cloud services (provider) and resource types (type) supported by Config in either of the following ways:Calling APIsYou can call the API for listing cl", + "product_code":"config", + "title":"Supported Services and Resource Types", + "uri":"rms_06_0100.html", + "doc_type":"api", + "p_code":"66", + "code":"68" + }, + { + "desc":"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.", + "product_code":"config", + "title":"Supported Resources", + "uri":"rms_02_0019.html", + "doc_type":"api", + "p_code":"66", + "code":"69" + }, + { + "desc":"NormalReturned ValueDescription200 OKThe results of GET and PUT operations are returned as expected.201 CreatedThe results of the POST operation are returned as expected.", + "product_code":"config", + "title":"Status Codes", + "uri":"rms_07_0200.html", + "doc_type":"api", + "p_code":"66", + "code":"70" + }, + { + "desc":"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.", + "product_code":"config", + "title":"Change History", + "uri":"rms_08_0000.html", + "doc_type":"api", + "p_code":"", + "code":"71" + } +] \ No newline at end of file diff --git a/docs/config/api-ref/ErrorCode.html b/docs/config/api-ref/ErrorCode.html new file mode 100644 index 00000000..18f304a8 --- /dev/null +++ b/docs/config/api-ref/ErrorCode.html @@ -0,0 +1,752 @@ + + +

Error Codes

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Status Code

+

Error Code

+

Error Message

+

Description

+

Solution

+

400

+

RMS.00010001

+

Some region is restricted to access.

+

Invalid region.

+

Specify a valid region.

+

400

+

RMS.00010002

+

Resource type invalid.

+

Invalid value for resource type.

+

Specify a valid value for resource type.

+

400

+

RMS.00010003

+

Service invalid.

+

Invalid value for service.

+

Specify a valid value for service.

+

400

+

RMS.00010004

+

Invalid parameter.

+

Invalid value for parameter.

+

Specify a valid value for parameter.

+

400

+

RMS.00010007

+

The max length of domainId must be less than or equal to 36.

+

domainId cannot be more than 36 characters.

+

Check whether the account ID is correct.

+

400

+

RMS.00010008

+

DomainId is illegal.

+

Invalid value for domainId.

+

Check whether the account ID is correct.

+

400

+

RMS.00010009

+

The max length of id must be less than or equal to 512.

+

id cannot be more than 512 characters.

+

Check request parameters.

+

400

+

RMS.00010010

+

Id is illegal.

+

Invalid value for id.

+

Specify a valid value for id.

+

400

+

RMS.00010011

+

The max length of name must be less than or equal to 256.

+

name cannot be more than 256 characters.

+

Check request parameters.

+

400

+

RMS.00010012

+

Name is illegal.

+

Invalid value for name.

+

Specify a valid value for name.

+

400

+

RMS.00010013

+

The size of resource type array must be between 1 and 100.

+

Invalid number of resource types. Value range: 1–100

+

Check request parameters.

+

400

+

RMS.00010014

+

The max length of resource type must be less than or equal to 40.

+

resource type cannot be more than 40 characters.

+

Check request parameters.

+

400

+

RMS.00010015

+

Resource type is illegal.

+

Invalid value for resource type.

+

Check request parameters.

+

400

+

RMS.00010016

+

The size of region id array must be between 1 and 10.

+

The number of region IDs must be 1 to 10.

+

Check request parameters.

+

400

+

RMS.00010017

+

The max length of region id must be less than or equal to 36.

+

region id cannot be more than 36 characters.

+

Check request parameters.

+

400

+

RMS.00010018

+

Region id is illegal.

+

Invalid value for region id.

+

Check request parameters.

+

400

+

RMS.00010019

+

The size of enterprise project array must be between 1 and 10.

+

Invalid number of enterprise projects. Value range: 1–10

+

Check request parameters.

+

400

+

RMS.00010020

+

Enterprise project is invalid.

+

Invalid value for enterprise project.

+

Specify a valid value for enterprise project.

+

400

+

RMS.00010021

+

The max length of project id array must be between 1 and 10.

+

The number of project IDs must be 1 to 10.

+

Check request parameters.

+

400

+

RMS.00010022

+

The max length of project id must be less than or equal to 36.

+

A project ID can contain 36 charaters at most

+

Check request parameters.

+

400

+

RMS.00010023

+

Project id is illegal.

+

Invalid value for project id.

+

Check request parameters.

+

400

+

RMS.00010024

+

The minimum value of limit must be greater than or equal to 1.

+

limit cannot be smaller than 1.

+

Check request parameters.

+

400

+

RMS.00010025

+

The maximum value of limit must be less than or equal to 200.

+

limit cannot be more than 200.

+

Check request parameters.

+

400

+

RMS.00010026

+

The minimum value of offset must be greater than or equal to 1.

+

offset cannot be smaller than 1.

+

Check request parameters.

+

400

+

RMS.00010027

+

The maximum value of offset must be less than or equal to 1000.

+

offset cannot be more than 1,000.

+

Check request parameters.

+

400

+

RMS.00010028

+

The number of tag keys must be between 1 and 5.

+

Invalid number of tag keys.

+

Enter 1 to 5 tag keys.

+

400

+

RMS.00010029

+

The length of a tag key must be less than or equal to 128.

+

tag key cannot be more than 36 characters.

+

Check request parameters.

+

400

+

RMS.00010030

+

The number of values in a tag key must be less than or equal to 5.

+

The number of values for a tag key cannot be more than 5.

+

Specify a valid number of tag key values.

+

400

+

RMS.00010031

+

The length of a tag value must be less than or equal to 255.

+

tag value cannot be more than 255 characters.

+

Check request parameters.

+

400

+

RMS.00010032

+

Tag value is illegal.

+

Invalid value for Tag value.

+

Specify a valid value for Tag value.

+

400

+

RMS.00010033

+

Tag key is illegal.

+

Invalid value for Tag key.

+

Specify a valid value for Tag key.

+

400

+

RMS.00010034

+

marker is illegal.

+

Invalid value for marker.

+

Specify a valid value for marker.

+

400

+

RMS.00010035

+

The length of marker must be between 4 and 400.

+

Invalid marker length. Value range: 4–400 characters

+

Enter 4 to 400 characters for marker.

+

400

+

RMS.00010036

+

The minimum value of limit must be greater than or equal to 1.

+

limit cannot be smaller than 1.

+

Specify a valid value for limit.

+

400

+

RMS.00010037

+

The maximum value of limit must be less than or equal to 200.

+

limit cannot be more than 200.

+

Specify a valid value for limit.

+

400

+

RMS.00010038

+

The minimum value of offset must be greater than or equal to 1.

+

offset cannot be smaller than 1.

+

Specify a valid value for offset.

+

400

+

RMS.00010039

+

The maximum value of offset must be less than or equal to 1000.

+

offset cannot be more than 1000.

+

Specify a valid value for offset.

+

400

+

RMS.00010040

+

The max length of auth action must be less than or equal to 64.

+

auth action cannot be more than 64 characters.

+

Enter 1 to 64 characters for auth action.

+

400

+

RMS.00010041

+

Policy assignment id is illegal.

+

Invalid policyAssignmentId.

+

Check request parameters.

+

400

+

RMS.00010042

+

Policy definition id is illegal.

+

Invalid value for policy definition id.

+

Specify a valid value for policy definition id.

+

400

+

RMS.00010043

+

The max length of policy assignment id must be less than or equal to 36.

+

policy assignment id cannot be more than 36 characters.

+

Enter 1 to 36 characters for policy assignment id.

+

400

+

RMS.00010044

+

The max length of policy definition id must be less than or equal to 36.

+

policy definition id cannot be more than 36 characters.

+

Enter 1 to 36 characters for policy definition id.

+

400

+

RMS.00010045

+

The max length of name must be less than or equal to 64.

+

name cannot be more than 64 characters.

+

Enter 1 to 64 characters for name.

+

400

+

RMS.00010046

+

Name is illegal.

+

Invalid value for name.

+

Specify a valid value for name.

+

400

+

RMS.00010047

+

The max length of keyword must be less than or equal to 64.

+

keyword cannot be more than 64 characters.

+

Enter 1 to 64 characters for keyword.

+

400

+

RMS.00010048

+

Keyword is illegal.

+

Invalid value for keyword .

+

Specify a valid value for keyword.

+

400

+

RMS.00010049

+

The max length of compliance state must be less than or equal to 16.

+

compliance state cannot be more than 16 characters.

+

Enter 1 to 16 characters for compliance state.

+

400

+

RMS.00010050

+

Compliance state is illegal.

+

Invalid value for compliance state.

+

Specify a valid value for compliance state.

+

400

+

RMS.00010051

+

The max length of policy assignment state must be less than or equal to 16.

+

policy assignment state cannot be more than 16 characters.

+

Enter 1 to 16 characters for policy assignment state.

+

400

+

RMS.00010052

+

Policy assignment state is illegal.

+

Invalid value for policy assignment state.

+

Check request parameters.

+

400

+

RMS.00010053

+

X-Language header is invalid.

+

Invalid value for X-Language header.

+

Specify a valid value for X-Language header.

+

400

+

RMS.00010054

+

The max length of queryId must be less than or equal to 36.

+

QueryId cannot be more than 36 characters.

+

Enter 1 to 36 characters for QueryId.

+

400

+

RMS.00010055

+

QueryId is illegal.

+

Invalid value for QueryId.

+

Specify a valid value for QueryId.

+

400

+

RMS.00010056

+

The minimum value of limit must be greater than or equal to 1.

+

limit cannot be smaller than 1.

+

Specify a valid value for limit.

+

400

+

RMS.00010057

+

The maximum value of limit must be less than or equal to 200.

+

limit cannot be more than 200.

+

Specify a valid value for limit.

+

400

+

RMS.00010058

+

Marker is illegal.

+

Invalid value for marker.

+

Specify a valid value for marker.

+

400

+

RMS.00010059

+

The length of marker must be between 4 and 400.

+

marker must contain 4 to 400 characters.

+

Enter 4 to 400 characters for marker.

+

400

+

RMS.00010060

+

Incorrect resource query language.

+

Incorrect advanced query statement.

+

Check whether the advanced query statement is correct.

+

400

+

RMS.00010061

+

Stored query name is illegal.

+

Invalid advanced query name.

+

Check the request parameter.

+

400

+

RMS.00010062

+

The length of stored query name must be between 1 and 64.

+

The advanced query name must contain 1 to 64 characters.

+

Check request parameters.

+

400

+

RMS.00010091

+

The tracker-config is not enabled.

+

The resource recorder is disabled.

+

Enable the resource recorder.

+

401

+

RMS.00010079

+

Incorrect IAM authentication information: Authorization header is missing.

+

IAM authentication failed.

+

Add an authentication header.

+

403

+

RMS.00010006

+

Access denied.

+

Access denied.

+

Check whether you have the required permissions.

+

404

+

RMS.00010005

+

Resource not found.

+

Resource not found.

+

Ensure that the resource exists.

+

429

+

RMS.00010063

+

ResourceQL is busy.

+

Advanced queries are busy.

+

Try again later.

+

500

+

RMS.INTERNAL.ERROR

+

Internal server error occurred.

+

Internal service error.

+

Try again later or contact customer service.

+
+
+
+
+
+
Parent topic: Appendixes
+
+
+ diff --git a/docs/config/api-ref/PARAMETERS.txt b/docs/config/api-ref/PARAMETERS.txt new file mode 100644 index 00000000..6da8d5f0 --- /dev/null +++ b/docs/config/api-ref/PARAMETERS.txt @@ -0,0 +1,3 @@ +version="" +language="en-us" +type="" \ No newline at end of file diff --git a/docs/config/api-ref/en-us_image_0000001466731780.png b/docs/config/api-ref/en-us_image_0000001466731780.png new file mode 100644 index 00000000..4a421d8a Binary files /dev/null and b/docs/config/api-ref/en-us_image_0000001466731780.png differ diff --git a/docs/config/api-ref/en-us_topic_0000001991150822.html b/docs/config/api-ref/en-us_topic_0000001991150822.html new file mode 100644 index 00000000..4584797f --- /dev/null +++ b/docs/config/api-ref/en-us_topic_0000001991150822.html @@ -0,0 +1,37 @@ + + +

Resource Relationships

+
+
+ + + + + + + + + + + + + +

Permission

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Querying details about resource relationships

+

GET /v1/resource-manager/domains/{domain_id}/all-resources/{resource_id}/relations

+

rms:resources:getRelation

+

√

+

x

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/config/api-ref/en-us_topic_0000002027710481.html b/docs/config/api-ref/en-us_topic_0000002027710481.html new file mode 100644 index 00000000..75f6c2b4 --- /dev/null +++ b/docs/config/api-ref/en-us_topic_0000002027710481.html @@ -0,0 +1,37 @@ + + +

Resource Change Records

+
+
+ + + + + + + + + + + + + +

Permission

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Querying change records of a resource

+

GET /v1/resource-manager/domains/{domain_id}/resources/{resource_id}/history

+

rms:resources:getHistory

+

√

+

x

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/config/api-ref/en-us_topic_0000002027750033.html b/docs/config/api-ref/en-us_topic_0000002027750033.html new file mode 100644 index 00000000..22d33e70 --- /dev/null +++ b/docs/config/api-ref/en-us_topic_0000002027750033.html @@ -0,0 +1,37 @@ + + +

Region Management

+
+
+ + + + + + + + + + + + + +

Permission

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Querying regions visible to you

+

GET /v1/resource-manager/domains/{domain_id}/regions

+

Not required

+

x

+

x

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/config/api-ref/public_sys-resources/caution_3.0-en-us.png b/docs/config/api-ref/public_sys-resources/caution_3.0-en-us.png new file mode 100644 index 00000000..60f60762 Binary files /dev/null and b/docs/config/api-ref/public_sys-resources/caution_3.0-en-us.png differ diff --git a/docs/config/api-ref/public_sys-resources/danger_3.0-en-us.png b/docs/config/api-ref/public_sys-resources/danger_3.0-en-us.png new file mode 100644 index 00000000..47a9c723 Binary files /dev/null and b/docs/config/api-ref/public_sys-resources/danger_3.0-en-us.png differ diff --git a/docs/config/api-ref/public_sys-resources/delta.gif b/docs/config/api-ref/public_sys-resources/delta.gif new file mode 100644 index 00000000..0d1b1f67 Binary files /dev/null and b/docs/config/api-ref/public_sys-resources/delta.gif differ diff --git a/docs/config/api-ref/public_sys-resources/deltaend.gif b/docs/config/api-ref/public_sys-resources/deltaend.gif new file mode 100644 index 00000000..cc7da0fc Binary files /dev/null and b/docs/config/api-ref/public_sys-resources/deltaend.gif differ diff --git a/docs/config/api-ref/public_sys-resources/icon-arrowdn.gif b/docs/config/api-ref/public_sys-resources/icon-arrowdn.gif new file mode 100644 index 00000000..37942803 Binary files /dev/null and b/docs/config/api-ref/public_sys-resources/icon-arrowdn.gif differ diff --git a/docs/config/api-ref/public_sys-resources/icon-arrowrt.gif b/docs/config/api-ref/public_sys-resources/icon-arrowrt.gif new file mode 100644 index 00000000..6aaaa11c Binary files /dev/null and b/docs/config/api-ref/public_sys-resources/icon-arrowrt.gif differ diff --git a/docs/config/api-ref/public_sys-resources/icon-caution.gif b/docs/config/api-ref/public_sys-resources/icon-caution.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/config/api-ref/public_sys-resources/icon-caution.gif differ diff --git a/docs/config/api-ref/public_sys-resources/icon-danger.gif b/docs/config/api-ref/public_sys-resources/icon-danger.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/config/api-ref/public_sys-resources/icon-danger.gif differ diff --git a/docs/config/api-ref/public_sys-resources/icon-huawei.gif b/docs/config/api-ref/public_sys-resources/icon-huawei.gif new file mode 100644 index 00000000..a31d60f8 Binary files /dev/null and b/docs/config/api-ref/public_sys-resources/icon-huawei.gif differ diff --git a/docs/config/api-ref/public_sys-resources/icon-note.gif b/docs/config/api-ref/public_sys-resources/icon-note.gif new file mode 100644 index 00000000..31be2b03 Binary files /dev/null and b/docs/config/api-ref/public_sys-resources/icon-note.gif differ diff --git a/docs/config/api-ref/public_sys-resources/icon-notice.gif b/docs/config/api-ref/public_sys-resources/icon-notice.gif new file mode 100644 index 00000000..40907065 Binary files /dev/null and b/docs/config/api-ref/public_sys-resources/icon-notice.gif differ diff --git a/docs/config/api-ref/public_sys-resources/icon-tip.gif b/docs/config/api-ref/public_sys-resources/icon-tip.gif new file mode 100644 index 00000000..c47bae05 Binary files /dev/null and b/docs/config/api-ref/public_sys-resources/icon-tip.gif differ diff --git a/docs/config/api-ref/public_sys-resources/icon-warning.gif b/docs/config/api-ref/public_sys-resources/icon-warning.gif new file mode 100644 index 00000000..079c79b2 Binary files /dev/null and b/docs/config/api-ref/public_sys-resources/icon-warning.gif differ diff --git a/docs/config/api-ref/public_sys-resources/note_3.0-en-us.png b/docs/config/api-ref/public_sys-resources/note_3.0-en-us.png new file mode 100644 index 00000000..57a0e1f5 Binary files /dev/null and b/docs/config/api-ref/public_sys-resources/note_3.0-en-us.png differ diff --git a/docs/config/api-ref/public_sys-resources/notice_3.0-en-us.png b/docs/config/api-ref/public_sys-resources/notice_3.0-en-us.png new file mode 100644 index 00000000..fa4b6499 Binary files /dev/null and b/docs/config/api-ref/public_sys-resources/notice_3.0-en-us.png differ diff --git a/docs/config/api-ref/public_sys-resources/warning_3.0-en-us.png b/docs/config/api-ref/public_sys-resources/warning_3.0-en-us.png new file mode 100644 index 00000000..def5c356 Binary files /dev/null and b/docs/config/api-ref/public_sys-resources/warning_3.0-en-us.png differ diff --git a/docs/config/api-ref/rms_01_0000.html b/docs/config/api-ref/rms_01_0000.html new file mode 100644 index 00000000..0f6850e2 --- /dev/null +++ b/docs/config/api-ref/rms_01_0000.html @@ -0,0 +1,17 @@ + + +

Before You Start

+
+
+ +
+ diff --git a/docs/config/api-ref/rms_01_0100.html b/docs/config/api-ref/rms_01_0100.html new file mode 100644 index 00000000..2c3bf9e0 --- /dev/null +++ b/docs/config/api-ref/rms_01_0100.html @@ -0,0 +1,13 @@ + + +

Introduction

+

With Config, you can search for, record, and continuously evaluate your resource configuration to make sure that your expectations are met.

+

This document describes the Config APIs. Parameter description and examples are provided. You can use provided APIs to perform operations on Config. For details about all supported operations, see API Overview.

+

If you plan to access Config through an API, ensure that you are familiar with Config concepts. For details, see Config User Guide.

+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/config/api-ref/rms_01_0200.html b/docs/config/api-ref/rms_01_0200.html new file mode 100644 index 00000000..cf1c80b9 --- /dev/null +++ b/docs/config/api-ref/rms_01_0200.html @@ -0,0 +1,11 @@ + + +

API Calling

+

Config supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see Calling APIs.

+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/config/api-ref/rms_01_0500.html b/docs/config/api-ref/rms_01_0500.html new file mode 100644 index 00000000..5e9c242c --- /dev/null +++ b/docs/config/api-ref/rms_01_0500.html @@ -0,0 +1,18 @@ + + +

Concepts

+
+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/config/api-ref/rms_01_0600.html b/docs/config/api-ref/rms_01_0600.html new file mode 100644 index 00000000..d3359fbd --- /dev/null +++ b/docs/config/api-ref/rms_01_0600.html @@ -0,0 +1,43 @@ + + +

Querying Data by Page

+

Some Config APIs support pagination query if you add limit and marker to the request URL. The value of marker must be the same as that returned in the last pagination query.

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Config parameter description

Parameter

+

Type

+

Mandatory

+

Description

+

limit

+

Integer

+

No

+

Restricts the number of records displayed on each page. If limit is invalid, error code 400 will be returned.

+

marker

+

String

+

No

+

Specifies the marker value returned in the last pagination query. If marker is invalid, error code 400 will be returned.

+
+
+
+
+
+
Parent topic: Before You Start
+
+
+ diff --git a/docs/config/api-ref/rms_02_0000.html b/docs/config/api-ref/rms_02_0000.html new file mode 100644 index 00000000..fffa5a64 --- /dev/null +++ b/docs/config/api-ref/rms_02_0000.html @@ -0,0 +1,50 @@ + + +

API Overview

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 API description

API

+

Description

+

Resource Query

+

APIs for querying resources, resource tags, resource quantity and summary, resources recorded by the resource recorder, and listing cloud services.

+

Resource Recorder

+

APIs for adding, deleting, modifying, and querying the resource recorder.

+

Resource Relationships

+

APIs for querying resource relationships and details.

+

Resource Change Records

+

API for querying resource change records.

+

Compliance

+

APIs for querying compliance policies; adding, deleting, modifying, querying, and running rules ; and querying and updating resource evaluation results.

+

Region Management

+

API for querying regions visible to a user

+

Advanced Queries

+

APIs for running, adding, deleting, modifying, and querying advanced queries

+
+
+
+ diff --git a/docs/config/api-ref/rms_02_0019.html b/docs/config/api-ref/rms_02_0019.html new file mode 100644 index 00000000..05dfcfd0 --- /dev/null +++ b/docs/config/api-ref/rms_02_0019.html @@ -0,0 +1,329 @@ + + +

Supported Resources

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Supported resources

Supported Service

+

Resource Type

+

Schema

+

Bare Metal Server (BMS)

+

BMSs

+

bms.servers

+

Cloud Backup and Recovery (CBR)

+

Vaults

+

cbr.vault

+

Cloud Container Engine (CCE)

+

Clusters

+

cce.clusters

+

Nodes

+

cce.nodes

+

Cloud Container Instance (CCI)

+

Pods

+

cci.pods

+

Config

+

Trackers

+

config.trackers

+

PolicyAssignments

+

config.policyAssignments

+

Cloud Search Service (CSS)

+

Clusters

+

css.clusters

+

DataArts Studio (DARTS)

+

Instances

+

dayu.instances

+

CDM Clusters

+

dayu.dlmClusters

+

Workspaces

+

dayu.workspaces

+

Database Security Service (DBSS)

+

Cloud Servers

+

dbss.cloudservers

+

Document Database Service (DDS)

+

Instances

+

dds.instances

+

Dedicated Host (DeH)

+

DeHs

+

deh.dedicatedhosts

+

Data Lake Insight (DLI)

+

Queues

+

dli.queues

+

Elastic Resource Pools

+

dli.elasticresourcepool

+

Distributed Message Service (DMS)

+

Kafka Instances

+

dms.kafkas

+

Data Replication Service (DRS)

+

Backup Migration Tasks

+

drs.backupMigrationJob

+

Disaster Recovery Tasks

+

drs.dataGuardJob

+

Data Synchronization Tasks

+

drs.synchronizationJob

+

Online Migration Tasks

+

drs.migrationJob

+

Data Warehouse Service (DWS)

+

Clusters

+

dws.clusters

+

Elastic Cloud Server (ECS)

+

ECSs

+

ecs.cloudservers

+

Elastic Load Balance (ELB)

+

Listeners

+

elb.listeners

+

Load Balancers

+

elb.loadbalancers

+

Enterprise Router (ER)

+

Enterprise Routers

+

er.instances

+

Attachments

+

er.attachments

+

Elastic Volume Service (EVS)

+

Disks

+

evs.volumes

+

GaussDB

+

Instances

+

gaussdb.instance

+

Nodes

+

gaussdb.nodes

+

GeminiDB

+

Instances

+

nosql.instances

+

Nodes

+

nosql.nodes

+

Image Management Service (IMS)

+

Images

+

ims.images

+

Key Management Service (KMS)

+

Keys

+

kms.keys

+

MapReduce Service (MRS)

+

Clusters

+

mrs.mrs

+

NAT Gateway (NAT)

+

Public NAT Gateways

+

nat.natGateways

+

Object Storage Service (OBS)

+

Buckets

+

obs.buckets

+

Relational Database Service (RDS)

+

Instances

+

rds.instances

+

Scalable File Service (SFS)

+

File Systems

+

sfsturbo.shares

+

Simple Message Notification (SMN)

+

Topics

+

smn.topic

+

Virtual Private Cloud (VPC)

+

VPCs

+

vpc.vpcs

+

Bandwidths

+

vpc.bandwidths

+

Security Groups

+

vpc.securityGroups

+

EIPs

+

vpc.publicips

+

Virtual Private Network (VPN)

+

VPN Connections

+

vpnaas.vpnConnections

+

VPN Gateways

+

vpnaas.vpnGateways

+

Web Application Firewall (WAF)

+

Policies

+

waf.policy

+

Certificates

+

waf.certificate

+

Instances

+

waf.instance

+
+
+
+
+
+
Parent topic: Appendixes
+
+
+ diff --git a/docs/config/api-ref/rms_03_0000.html b/docs/config/api-ref/rms_03_0000.html new file mode 100644 index 00000000..f716e205 --- /dev/null +++ b/docs/config/api-ref/rms_03_0000.html @@ -0,0 +1,9 @@ + + +

Calling APIs

+

Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://Endpoint/uri. In the URL, uri indicates the resource path, that is, the API access path.

+

Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted by using JSON messages, with the media type represented by Application/json.

+

For details about how to use APIs, see API Usage Guidelines.

+
+
+ diff --git a/docs/config/api-ref/rms_04_0000.html b/docs/config/api-ref/rms_04_0000.html new file mode 100644 index 00000000..a14ee698 --- /dev/null +++ b/docs/config/api-ref/rms_04_0000.html @@ -0,0 +1,23 @@ + + +

APIs

+
+
+ +
+ diff --git a/docs/config/api-ref/rms_04_0100.html b/docs/config/api-ref/rms_04_0100.html new file mode 100644 index 00000000..bfd18ba6 --- /dev/null +++ b/docs/config/api-ref/rms_04_0100.html @@ -0,0 +1,40 @@ + + +

Resource Query

+

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/config/api-ref/rms_04_0101.html b/docs/config/api-ref/rms_04_0101.html new file mode 100644 index 00000000..0d260570 --- /dev/null +++ b/docs/config/api-ref/rms_04_0101.html @@ -0,0 +1,509 @@ + + +

Querying Resources of a Specific Type

+

Function

This API is used to query specified resources.To call this API, you must have the rms:resources:list permission. For example,if you need to query the ecs.cloudservers resource type, set the provider to ecs, and type to cloudservers in the API request. For details about the cloud services (provider) and resource types (type), see the Supported Services and Resource Types section in the appendix.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/provider/{provider}/type/{type}/resources

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+

provider

+

Yes

+

String

+

Specifies the cloud service name.

+

Maximum: 20

+

type

+

Yes

+

String

+

Specifies the resource type.

+

Maximum: 32

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

region_id

+

No

+

String

+

Specifies the region ID.

+

Maximum: 36

+

ep_id

+

No

+

String

+

Specifies the enterprise project ID.

+

Maximum: 36

+

tag

+

No

+

Map<String,String>

+

Specifies the tag.

+

limit

+

No

+

Integer

+

Specifies the maximum number of records to return.

+

Minimum: 1

+

Maximum: 200

+

Default: 200

+

marker

+

No

+

String

+

Specifies the pagination parameter.

+

Minimum: 4

+

Maximum: 400

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

resources

+

Array of ResourceEntity objects

+

Specifies the resource list.

+

page_info

+

PageInfo object

+

Specifies the pagination object.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 ResourceEntity

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the resource ID.

+

name

+

String

+

Specifies the resource name.

+

provider

+

String

+

Specifies the cloud service name.

+

type

+

String

+

Specifies the resource type.

+

region_id

+

String

+

Specifies the region ID.

+

project_id

+

String

+

Specifies the project ID in IaaS OpenStack.

+

project_name

+

String

+

Specifies the project name in IaaS OpenStack.

+

ep_id

+

String

+

Specifies the enterprise project ID.

+

ep_name

+

String

+

Specifies the name of an enterprise project.

+

checksum

+

String

+

Specifies the resource checksum.

+

created

+

String

+

Specifies the time when the resource was created.

+

updated

+

String

+

Specifies the time when the resource was updated.

+

provisioning_state

+

String

+

Specifies the status of a resource operation.

+

state

+

String

+

Resource state. The value can be normal or deleted.

+

tags

+

Map<String,String>

+

Specifies the resource tag.

+

properties

+

Map<String,Object>

+

Specifies the detailed properties of the resource.

+

Resource attributes vary based on different resources. For details about resource attribute parameter description, see the documentation of related services.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 PageInfo

Parameter

+

Type

+

Description

+

current_count

+

Integer

+

Specifies the resource quantity on the current page.

+

Minimum: 0

+

Maximum: 200

+

next_marker

+

String

+

Specifies the marker value of the next page.

+

Minimum: 4

+

Maximum: 400

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

Querying all VMs in current account

+
GET https://{endpoint}/v1/resource-manager/domains/{domain_id}/provider/ecs/type/cloudServers/resources
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "page_info" : {
+    "current_count" : 2,
+    "next_marker" : null
+  },
+  "resources" : [ {
+    "checksum" : "89ca775e88e04b2c200ccbf9e219ad0d7da42e3f446e5c953d443288134eec41",
+    "created" : "2020-02-21T08:41:05Z",
+    "ep_id" : "0",
+    "ep_name" : "default",
+    "id" : "7ffd8564-d88a-4bc9-ab51-d8b79a57d0e6",
+    "name" : "ecs-test-1",
+    "project_id" : "059b5e0a2500d5552fa1c00adada8c06",
+    "project_name" : "project_name",
+    "properties" : {
+      "status" : "ACTIVE"
+    },
+    "provider" : "ecs",
+    "provisioning_state" : "Succeeded",
+    "region_id" : "regionid1",
+    "tags" : {
+      "use" : "test"
+    },
+    "type" : "cloudServers",
+    "updated" : "2020-02-21T08:41:05Z"
+  }, {
+    "checksum" : "db2aad42804951c03a724b7501da9b6b4c14d319dd319d76bb7c658f256a37b0",
+    "created" : "2020-02-24T08:43:05Z",
+    "ep_id" : "0",
+    "ep_name" : "default",
+    "id" : "b63b33b7-f48c-4048-995b-0445d124a445",
+    "name" : "ecs-test-2",
+    "project_id" : "059b5e0a2500d5552fa1c00adada8c06",
+    "project_name" : "project_name_1",
+    "properties" : {
+      "status" : "ACTIVE"
+    },
+    "provider" : "ecs",
+    "provisioning_state" : "Succeeded",
+    "region_id" : "regionid1",
+    "tags" : {
+      "use" : "test1"
+    },
+    "type" : "cloudServers",
+    "updated" : "2020-08-11T11:55:08Z"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

User authentication failed.

+

500

+

Sever error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Query
+
+
+ diff --git a/docs/config/api-ref/rms_04_0102.html b/docs/config/api-ref/rms_04_0102.html new file mode 100644 index 00000000..ac612c26 --- /dev/null +++ b/docs/config/api-ref/rms_04_0102.html @@ -0,0 +1,379 @@ + + +

Listing Cloud Services

+

Function

Querying cloud services, resources, and regions

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/providers

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

offset

+

No

+

Integer

+

Specifies the pagination offset.

+

Minimum: 1

+

Maximum: 1000

+

limit

+

No

+

Integer

+

Specifies the maximum number of records to return.

+

Minimum: 1

+

Maximum: 200

+

Default: 200

+

track

+

No

+

String

+

Specifies whether resources are collected by default. tracked indicates that resources are collected by default, and untracked indicates that resources are not collected by default.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Language

+

No

+

String

+

Language of the returned message.

+

Default: en-us

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

resource_providers

+

Array of ResourceProviderResponse objects

+

Specifies the list of cloud service details.

+

total_count

+

Integer

+

Specifies the total number of cloud services.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 5 ResourceProviderResponse

Parameter

+

Type

+

Description

+

provider

+

String

+

Specifies the cloud service name.

+

display_name

+

String

+

Specifies the display name of the cloud service. You can set the language by configuring X-Language in the request header.

+

category_display_name

+

String

+

Specifies the display name of the cloud service type. You can set the language by configuring X-Language in the request header.

+

resource_types

+

Array of ResourceTypeResponse objects

+

Specifies the resource type list.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 ResourceTypeResponse

Parameter

+

Type

+

Description

+

name

+

String

+

Specifies the resource type.

+

display_name

+

String

+

Specifies the display name of the resource type. You can set the language by configuring X-Language in the request header.

+

global

+

Boolean

+

Specifies whether the resource is a global resource.

+

regions

+

Array of strings

+

Specifies the list of supported regions.

+

console_endpoint_id

+

String

+

Specifies the console endpoint ID.

+

console_list_url

+

String

+

Specifies the URL of the resource list page on the console.

+

console_detail_url

+

String

+

Specifies the URL of the resource details page on the console.

+

track

+

String

+

Specifies whether resources are collected by default. tracked indicates that resources are collected by default, and untracked indicates that resources are not collected by default.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "total_count" : 2,
+  "resource_providers" : [ {
+    "provider" : "ecs",
+    "display_name" : "ECS",
+    "category_display_name" : "Compute",
+    "resource_types" : [ {
+      "name" : "cloudservers",
+      "display_name" : "Cloud servers",
+      "global" : false,
+      "regions" : [ "regionid1", "regionid2", "regionid3", "regionid4", "regionid5", "regionid6" ],
+      "console_endpoint_id" : "ecm",
+      "console_list_url" : "#/ecs/manager/vmList",
+      "console_detail_url" : "#/ecs/manager/ecsDetail?instanceId={id}",
+      "track" : "tracked"
+    } ]
+  }, {
+    "provider" : "vpc",
+    "display_name" : "VPC",
+    "category_display_name" : "Networking",
+    "resource_types" : [ {
+      "name" : "vpcs",
+      "display_name" : "VPC",
+      "global" : false,
+      "regions" : [ "regionid1", "regionid2", "regionid3", "regionid4", "regionid5", "regionid6" ],
+      "console_endpoint_id" : "vpc",
+      "console_list_url" : "#/vpcs",
+      "console_detail_url" : "#/vpc/vpcmanager/vpcDetail/subnets?vpcId={id}",
+      "track" : "tracked"
+    }, {
+      "name" : "bandwidths",
+      "display_name" : "Shared bandwidth",
+      "global" : false,
+      "regions" : [ "regionid1", "regionid2", "regionid3", "regionid4", "regionid5", "regionid6" ],
+      "console_endpoint_id" : "vpc",
+      "console_list_url" : "#/vpc/vpcmanager/shareBandwidth",
+      "console_detail_url" : "#/vpc/vpcmanager/shareBandwidth?bandwidthId={id}",
+      "track" : "tracked"
+    }, {
+      "name" : "securityGroups",
+      "display_name" : "Security groups",
+      "global" : false,
+      "regions" : [ "regionid1", "regionid2", "regionid5", "regionid6" ],
+      "console_endpoint_id" : "vpc",
+      "console_list_url" : "#/secGroups",
+      "console_detail_url" : "#/vpc/vpcmanager/sgDetail/sgRules?instanceId={id}",
+      "track" : "tracked"
+    }, {
+      "name" : "publicips",
+      "display_name" : "EIPs",
+      "global" : false,
+      "regions" : [ "regionid1", "regionid2", "regionid3", "regionid4", "regionid6" ],
+      "console_endpoint_id" : "vpc",
+      "console_list_url" : "#/vpc/vpcmanager/eips",
+      "console_detail_url" : "#/vpc/vpcmanager/eipDetailNew?eipId={id}",
+      "track" : "tracked"
+    } ]
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Query
+
+
+ diff --git a/docs/config/api-ref/rms_04_0103.html b/docs/config/api-ref/rms_04_0103.html new file mode 100644 index 00000000..748fa783 --- /dev/null +++ b/docs/config/api-ref/rms_04_0103.html @@ -0,0 +1,465 @@ + + +

Querying a Resource

+

Function

This API is used to query details of a resource based on its ID. You must have the rms:resources:get permission. For example, to query ECSs whose resource type is ecs.cloudservers, you must set provider to ecs and type to cloudservers in the request. For details about the cloud services (provider) and resource types (type), see "Appendix-Supported Services and Resource Types".

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/provider/{provider}/type/{type}/resources/{resource_id}

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+

provider

+

Yes

+

String

+

Specifies the cloud service name.

+

Maximum: 20

+

type

+

Yes

+

String

+

Specifies the resource type.

+

Maximum: 32

+

resource_id

+

Yes

+

String

+

Specifies the resource ID.

+

Maximum: 512

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the resource ID.

+

name

+

String

+

Specifies the resource name.

+

provider

+

String

+

Specifies the cloud service name.

+

type

+

String

+

Specifies the resource type.

+

region_id

+

String

+

Specifies the region ID.

+

project_id

+

String

+

Specifies the project ID in IaaS OpenStack.

+

project_name

+

String

+

Specifies the project name in IaaS OpenStack.

+

ep_id

+

String

+

Specifies the enterprise project ID.

+

ep_name

+

String

+

Specifies the name of an enterprise project.

+

checksum

+

String

+

Specifies the resource checksum.

+

created

+

String

+

Specifies the time when the resource was created.

+

updated

+

String

+

Specifies the time when the resource was updated.

+

provisioning_state

+

String

+

Specifies the status of a resource operation.

+

state

+

String

+

Resource state. The value can be normal or deleted.

+

tags

+

Map<String,String>

+

Specifies the resource tag.

+

properties

+

Map<String,Object>

+

Specifies the detailed properties of the resource.

+

Resource attributes vary based on different resources. For details about resource attribute parameter description, see the documentation of related services.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

GET https://{endpoint}/v1/resource-manager/domains/059b5c937100d3e40ff0c00a7675a0a0/provider/ecs/type/cloudservers/resources/00337e93-82d1-40ca-911f-07cff94587cc
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "id" : "00337e93-82d1-40ca-911f-07cff94587cc",
+  "name" : "dev_machine",
+  "provider" : "ecs",
+  "type" : "cloudservers",
+  "region_id" : "regionid4",
+  "project_id" : "39c2af998c334ed6bcbb75b27318f7cc",
+  "project_name" : "project_name",
+  "ep_id" : "0",
+  "ep_name" : "default",
+  "checksum" : "3a0075409edb156a74e041b7479f0d5993be1d62b4ccd2af3a1dd01ec80c8b39",
+  "created" : "2019-11-20T06:24:43Z",
+  "updated" : "2020-07-17T08:30:52Z",
+  "provisioning_state" : "Succeeded",
+  "tags" : {
+    "usage" : "Display"
+  },
+  "properties" : {
+    "accessIpv4" : "",
+    "hostName" : "dev-machine",
+    "addresses" : [ {
+      "OsExtIpsType" : "fixed",
+      "OsExtIpsPortId" : "f2fa750a-e2ab-434f-b14a-bfe7c8cea0cc",
+      "addr" : "192.168.1.212",
+      "version" : 4,
+      "OsExtIpsMacAddr" : "fa:16:3e:6e:cf:33"
+    }, {
+      "OsExtIpsType" : "floating",
+      "OsExtIpsPortId" : "f2fa750a-e2ab-434f-b14a-bfe7c8cea0cc",
+      "addr" : "100.85.225.33",
+      "version" : 4,
+      "OsExtIpsMacAddr" : "fa:16:3e:6e:cf:33"
+    } ],
+    "accessIpv6" : "",
+    "metadata" : {
+      "chargingMode" : "0",
+      "meteringImageType" : "private",
+      "imageName" : "resource-manager-devmachine-template",
+      "meteringImageId" : "9bcaace4-b8da-4008-a352-3f72e1f25333",
+      "meteringResourcesPerCode" : "si2.large.2.linux",
+      "vpcId" : "cf403ef5-90df-4e7e-829d-5d21b1cb7d1e",
+      "osBit" : "64"
+    },
+    "OsExtStsVmState" : "active",
+    "configDrive" : "",
+    "OsExtStsPowerState" : 1,
+    "hostId" : "3c381dcfc3e628c1a504ad94ba8c4e89081306455273701333f32921",
+    "securityGroup" : [ {
+      "name" : "default",
+      "id" : "5d55b397-ad9c-462d-af72-6599cb941c49"
+    } ],
+    "ExtVolumesAttached" : [ {
+      "bootIndex" : "0",
+      "id" : "010d940e-a73e-417b-85ae-51b76c0d2ba0",
+      "device" : "/dev/vda"
+    } ],
+    "userId" : "e311190745e94cc09d62d5779e55912d",
+    "flavor" : {
+      "disk" : "0",
+      "name" : "Si2.large.2",
+      "id" : "Si2.large.2",
+      "vcpus" : "2",
+      "ram" : "4096"
+    },
+    "OsDcfDiskConfig" : "MANUAL",
+    "hostStatus" : "UP",
+    "OsSrvUsgLaunchedAt" : "2019-11-20T06:24:56.000000",
+    "OsExtAz" : "regionid4a",
+    "progress" : 0,
+    "locked" : false,
+    "OS-EXT-SRV-ATTR" : {
+      "hostName" : "dev-machine",
+      "kernelId" : "",
+      "ramdiskId" : "",
+      "reservationId" : "r-hhux9o7m",
+      "instanceName" : "instance-0009cb50",
+      "host" : "regionid4a-pod01.regionid4",
+      "rootDeviceName" : "/dev/vda",
+      "hypervisorHostName" : "nova001@2",
+      "launchIndex" : 0
+    },
+    "status" : "ACTIVE"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

User authentication failed.

+

404

+

Resources not found.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Query
+
+
+ diff --git a/docs/config/api-ref/rms_04_0104.html b/docs/config/api-ref/rms_04_0104.html new file mode 100644 index 00000000..d47282d0 --- /dev/null +++ b/docs/config/api-ref/rms_04_0104.html @@ -0,0 +1,526 @@ + + +

Querying All Resources Under Your Account

+

Function

This API is used to query all resources under your account and you must have the **rms:resources:list **permission.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/all-resources

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

region_id

+

No

+

String

+

Specifies the region ID.

+

Maximum: 36

+

ep_id

+

No

+

String

+

Specifies the enterprise project ID.

+

Maximum: 36

+

type

+

No

+

String

+

Specifies the resource type in the format of provider.type.

+

Maximum: 40

+

limit

+

No

+

Integer

+

Specifies the maximum number of resources to return.

+

Minimum: 1

+

Maximum: 200

+

Default: 100

+

marker

+

No

+

String

+

Specifies the pagination parameter.

+

Minimum: 4

+

Maximum: 400

+

id

+

No

+

String

+

Specifies the resource ID.

+

Maximum: 512

+

name

+

No

+

String

+

Specifies the resource name.

+

Maximum: 256

+

tags

+

No

+

Array

+

Specifies tags. The format is key or key=value.

+

Array Length: 1 - 5

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

resources

+

Array of ResourceEntity objects

+

Specifies the resource list.

+

page_info

+

PageInfo object

+

Specifies the pagination object.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 ResourceEntity

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the resource ID.

+

name

+

String

+

Specifies the resource name.

+

provider

+

String

+

Specifies the cloud service name.

+

type

+

String

+

Specifies the resource type.

+

region_id

+

String

+

Specifies the region ID.

+

project_id

+

String

+

Specifies the project ID in IaaS OpenStack.

+

project_name

+

String

+

Specifies the project name in IaaS OpenStack.

+

ep_id

+

String

+

Specifies the enterprise project ID.

+

ep_name

+

String

+

Specifies the name of an enterprise project.

+

checksum

+

String

+

Specifies the resource checksum.

+

created

+

String

+

Specifies the time when the resource was created.

+

updated

+

String

+

Specifies the time when the resource was updated.

+

provisioning_state

+

String

+

Specifies the status of a resource operation.

+

state

+

String

+

Resource state. The value can be normal or deleted.

+

tags

+

Map<String,String>

+

Specifies the resource tag.

+

properties

+

Map<String,Object>

+

Specifies the detailed properties of the resource.

+

Resource attributes vary based on different resources. For details about resource attribute parameter description, see the documentation of related services.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 PageInfo

Parameter

+

Type

+

Description

+

current_count

+

Integer

+

Specifies the resource quantity on the current page.

+

Minimum: 0

+

Maximum: 200

+

next_marker

+

String

+

Specifies the marker value of the next page.

+

Minimum: 4

+

Maximum: 400

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "resources" : [ {
+    "id" : "3ccd9191-6a5e-4939-a971-4652db18b370",
+    "name" : "elb-265a",
+    "provider" : "elb",
+    "type" : "loadbalancers",
+    "region_id" : "regionid1",
+    "project_id" : "05498e12458025102ff5c0061a584a9f",
+    "project_name" : "regionid1_region_service",
+    "ep_id" : "0",
+    "ep_name" : "default",
+    "checksum" : "6e0271b107b764b19acb235f45c0d852f72104fe1d4b32970686e7eae8e87bf4",
+    "created" : "2020-02-29T09:39:19Z",
+    "updated" : "2020-02-29T09:39:19Z",
+    "provisioning_state" : "Succeeded",
+    "tags" : { },
+    "properties" : {
+      "tenant_id" : "05498e12458025102ff5c0061a584a9f",
+      "listeners" : [ {
+        "id" : "37de3be0-1803-43e2-9bb5-243b4b30b771"
+      } ],
+      "provisioning_status" : "ACTIVE",
+      "description" : ""
+    }
+  }, {
+    "id" : "a6e56d05501944d3b2507ba506a43744",
+    "name" : "console",
+    "provider" : "cdn",
+    "type" : "domains",
+    "region_id" : "global",
+    "project_id" : "",
+    "project_name" : "",
+    "ep_id" : "0",
+    "ep_name" : "default",
+    "checksum" : "56afa8b76428f90e9abfbe5cbf33535d8816166114d32eeb119658d6c59eceda",
+    "created" : "2020-01-04T13:42:37Z",
+    "updated" : "2020-01-15T04:23:01Z",
+    "provisioning_state" : "Succeeded",
+    "tags" : { },
+    "properties" : {
+      "domain_name" : "console",
+      "domain_status" : "offline",
+      "business_type" : "WEB",
+      "modify_time" : 1579062181463,
+      "cname" : "console"
+    }
+  } ],
+  "page_info" : {
+    "current_count" : 2,
+    "next_marker" : null
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

User Authentication failed.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Query
+
+
+ diff --git a/docs/config/api-ref/rms_04_0105.html b/docs/config/api-ref/rms_04_0105.html new file mode 100644 index 00000000..7bebf74d --- /dev/null +++ b/docs/config/api-ref/rms_04_0105.html @@ -0,0 +1,386 @@ + + +

Querying a Resource Under Your Account

+

Function

This API is used to query a resource under your account.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/all-resources/{resource_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+

resource_id

+

Yes

+

String

+

Specifies the resource ID.

+

Maximum: 512

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the resource ID.

+

name

+

String

+

Specifies the resource name.

+

provider

+

String

+

Specifies the cloud service name.

+

type

+

String

+

Specifies the resource type.

+

region_id

+

String

+

Specifies the region ID.

+

project_id

+

String

+

Specifies the project ID in IaaS OpenStack.

+

project_name

+

String

+

Specifies the project name in IaaS OpenStack.

+

ep_id

+

String

+

Specifies the enterprise project ID.

+

ep_name

+

String

+

Specifies the name of an enterprise project.

+

checksum

+

String

+

Specifies the resource checksum.

+

created

+

String

+

Specifies the time when the resource was created.

+

updated

+

String

+

Specifies the time when the resource was updated.

+

provisioning_state

+

String

+

Specifies the status of a resource operation.

+

state

+

String

+

Resource state. The value can be normal or deleted.

+

tags

+

Map<String,String>

+

Specifies the resource tag.

+

properties

+

Map<String,Object>

+

Specifies the detailed properties of the resource.

+

Resource attributes vary based on different resources. For details about resource attribute parameter description, see the documentation of related services.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

GET https://{endpoint}/v1/resource-manager/domains/daf2557fc0de4da09e128441baa71697/all-resources/009e9359-70e4-4570-a3a8-69a6c53d5c36
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "id": "009e9359-70e4-4570-a3a8-69a6c53d5c36",
+  "name": "ecs-aziuzko",
+  "provider": "evs",
+  "type": "volumes",
+  "region_id": "eu-de",
+  "project_id": "ecabfaea4fd6425ba80d6f8860d8847d",
+  "project_name": "eu-de_TSRU",
+  "ep_id": "0",
+  "ep_name": "default",
+  "checksum": "793ebafeb29b2ffdd3df4b018dd9c8e535ea4eba9f19cd6079d7bf998d51c33d",
+  "created": "2022-12-21T14:14:43.811Z",
+  "updated": "2022-12-21T14:14:50.935Z",
+  "provisioning_state": "Succeeded",
+  "state": "Normal",
+  "tags": {},
+  "properties": {
+    "shareable": false,
+    "volumeType": "SAS",
+    "metadata": {
+      "readonly": "False",
+      "attachedMode": "rw"
+    },
+    "attachments": [
+      {
+        "attachedAt": "2022-12-21T14:14:50.879146",
+        "volumeId": "009e9359-70e4-4570-a3a8-69a6c53d5c36",
+        "id": "009e9359-70e4-4570-a3a8-69a6c53d5c36",
+        "attachmentId": "4e84732b-3a7f-43df-9c05-8f5298651ea9",
+        "serverId": "d418cc33-dd14-43f7-aa1e-a72ecab1a9b3",
+        "device": "/dev/vda"
+      }
+    ],
+    "replicationStatus": "disabled",
+    "availabilityZone": "eu-de-01",
+    "bootable": "true",
+    "userId": "e3b5c19edad843e682a6a21a3b950127",
+    "volTenantAttrTenantId": "ecabfaea4fd6425ba80d6f8860d8847d",
+    "size": 6,
+    "encrypted": false,
+    "volumeImageMetadata": {
+      "virtualEnvType": "FusionCompute",
+      "isregistered": "true",
+      "imageSourceType": "uds",
+      "supportXenGpuType": "false",
+      "minDisk": "6",
+      "platform": "Ubuntu",
+      "osVersion": "Ubuntu 22.04 server 64bit",
+      "minRam": "1024",
+      "name": "Standard_Ubuntu_22.04_latest",
+      "checksum": "a1733c9887975ed17d6e4a3131f89ab8",
+      "osBit": "64",
+      "osType": "Linux",
+      "containerFormat": "bare",
+      "supportXen": "true",
+      "id": "e36a291e-5829-470a-9eeb-cb6c31ceddd4",
+      "imageSize": "1246982144",
+      "supportKvm": "true",
+      "diskFormat": "zvhd2",
+      "imageType": "gold"
+    },
+    "volHostAttrHost": "pod01.eu-de-01#1",
+    "multiattach": false,
+    "status": "in-use"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

User authentication failed.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Query
+
+
+ diff --git a/docs/config/api-ref/rms_04_0106.html b/docs/config/api-ref/rms_04_0106.html new file mode 100644 index 00000000..dbd19cff --- /dev/null +++ b/docs/config/api-ref/rms_04_0106.html @@ -0,0 +1,324 @@ + + +

Querying Resource Tags

+

Function

This API is used to query all resource tags under your account.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/all-resources/tags

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

Specifies the name of the tag key.

+

Maximum: 128

+

marker

+

No

+

String

+

Specifies the pagination parameter.

+

Minimum: 4

+

Maximum: 400

+

limit

+

No

+

Integer

+

Specifies the maximum number of resources to return.

+

Minimum: 1

+

Maximum: 200

+

Default: 100

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

tags

+

Array of TagEntity objects

+

Specifies tags.

+

page_info

+

PageInfo object

+

Specifies the pagination object.

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 TagEntity

Parameter

+

Type

+

Description

+

key

+

String

+

Specifies the tag key.

+

value

+

Array of strings

+

Specifies tag values.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 PageInfo

Parameter

+

Type

+

Description

+

current_count

+

Integer

+

Specifies the resource quantity on the current page.

+

Minimum: 0

+

Maximum: 200

+

next_marker

+

String

+

Specifies the marker value of the next page.

+

Minimum: 4

+

Maximum: 400

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

GET https://{endpoint}/v1/resource-manager/domains/059b5c937100d3e40ff0c00a7675a0a0/all-resources/tags
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "tags" : [ {
+    "key" : "chloe",
+    "value" : [ "a", "b" ]
+  } ],
+  "page_info" : {
+    "current_count" : 1,
+    "next_marker" : null
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

User authentication failed.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Query
+
+
+ diff --git a/docs/config/api-ref/rms_04_0107.html b/docs/config/api-ref/rms_04_0107.html new file mode 100644 index 00000000..2b645bb5 --- /dev/null +++ b/docs/config/api-ref/rms_04_0107.html @@ -0,0 +1,291 @@ + + +

Querying the Number of Resources

+

Function

This API is used to query the number of resources.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/all-resources/count

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

No

+

String

+

Specifies the resource ID.

+

Maximum: 512

+

name

+

No

+

String

+

Specifies the resource name.

+

Maximum: 256

+

type

+

No

+

Array

+

Specifies resource types in the format of provider.type.

+

Array Length: 1 - 100

+

region_id

+

No

+

Array

+

Specifies the regions.

+

Array Length: 1 - 10

+

ep_id

+

No

+

Array

+

Specifies enterprise project IDs.

+

Array Length: 1 - 10

+

project_id

+

No

+

Array

+

Specifies the project ID.

+

Array Length: 1 - 10

+

tags

+

No

+

Array

+

Specifies tags. The format is key or key=value.

+

Array Length: 1 - 5

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

total_count

+

Integer

+

Specifies the total number of resources.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

GET https://{endpoint}/v1/resource-manager/domains/059b5c937100d3e40ff0c00a7675a0a0/all-resources/count
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "total_count" : 345
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

User authentication failed.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Query
+
+
+ diff --git a/docs/config/api-ref/rms_04_0108.html b/docs/config/api-ref/rms_04_0108.html new file mode 100644 index 00000000..7e25f296 --- /dev/null +++ b/docs/config/api-ref/rms_04_0108.html @@ -0,0 +1,375 @@ + + +

Querying a Resource Summary

+

Function

This API is used to query a resource summary.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/all-resources/summary

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Specifies the resource name.

+

Maximum: 256

+

type

+

No

+

Array

+

Specifies resource types in the format of provider.type.

+

Array Length: 1 - 100

+

region_id

+

No

+

Array

+

Specifies the regions.

+

Array Length: 1 - 10

+

ep_id

+

No

+

Array

+

Specifies enterprise project IDs.

+

Array Length: 1 - 10

+

project_id

+

No

+

Array

+

Specifies the project ID.

+

Array Length: 1 - 10

+

tags

+

No

+

Array

+

Specifies tags. The format is key or key=value.

+

Array Length: 1 - 5

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

[items]

+

Array of ResourceSummaryResponseItem objects

+

Specifies the list of resource summary information.

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 ResourceSummaryResponseItem

Parameter

+

Type

+

Description

+

provider

+

String

+

Specifies the cloud service name.

+

types

+

Array of types objects

+

Specifies the resource type list.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 types

Parameter

+

Type

+

Description

+

type

+

String

+

Specifies the resource type.

+

regions

+

Array of regions objects

+

Specifies the regions.

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 regions

Parameter

+

Type

+

Description

+

region_id

+

String

+

Specifies the region ID.

+

count

+

Long

+

Specifies the number of resources of this type in the current region.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

GET https://{endpoint}/v1/resource-manager/domains/059b5c937100d3e40ff0c00a7675a0a0/all-resources/summary
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
[ {
+  "provider" : "obs",
+  "types" : [ {
+    "type" : "buckets",
+    "regions" : [ {
+      "region_id" : "regionid1",
+      "count" : 5
+    } ]
+  } ]
+}, {
+  "provider" : "ecs",
+  "types" : [ {
+    "type" : "cloudservers",
+    "regions" : [ {
+      "region_id" : "regionid2",
+      "count" : 1
+    } ]
+  } ]
+} ]
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

User authentication failed.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Query
+
+
+ diff --git a/docs/config/api-ref/rms_04_0109.html b/docs/config/api-ref/rms_04_0109.html new file mode 100644 index 00000000..fd3f2c1d --- /dev/null +++ b/docs/config/api-ref/rms_04_0109.html @@ -0,0 +1,558 @@ + + +

Listing Resources Recorded by the Resource Recorder

+

Function

Querying all resources recorded by the resource recorder. To call this API, you must have the rms:resources:list permission.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/tracked-resources

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

region_id

+

No

+

String

+

Specifies the region ID.

+

Maximum: 36

+

ep_id

+

No

+

String

+

Specifies the enterprise project ID.

+

Maximum: 36

+

type

+

No

+

String

+

Specifies the resource type in the format of provider.type.

+

Maximum: 40

+

limit

+

No

+

Integer

+

Specifies the maximum number of resources to return.

+

Minimum: 1

+

Maximum: 200

+

Default: 100

+

marker

+

No

+

String

+

Specifies the pagination parameter.

+

Minimum: 4

+

Maximum: 400

+

id

+

No

+

String

+

Specifies the resource ID.

+

Maximum: 512

+

name

+

No

+

String

+

Specifies the resource name.

+

Maximum: 256

+

tags

+

No

+

Array

+

Specifies tags. The format is key or key=value.

+

Array Length: 1 - 5

+

resource_deleted

+

No

+

Boolean

+

Indicating whether deleted resources need to be returned. This parameter is set to false by default.

+

Default: false

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

resources

+

Array of ResourceEntity objects

+

Specifies the resource list.

+

page_info

+

PageInfo object

+

Specifies the pagination object.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 ResourceEntity

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the resource ID.

+

name

+

String

+

Specifies the resource name.

+

provider

+

String

+

Specifies the cloud service name.

+

type

+

String

+

Specifies the resource type.

+

region_id

+

String

+

Specifies the region ID.

+

project_id

+

String

+

Specifies the project ID in IaaS OpenStack.

+

project_name

+

String

+

Specifies the project name in IaaS OpenStack.

+

ep_id

+

String

+

Specifies the enterprise project ID.

+

ep_name

+

String

+

Specifies the name of an enterprise project.

+

checksum

+

String

+

Specifies the resource checksum.

+

created

+

String

+

Specifies the time when the resource was created.

+

updated

+

String

+

Specifies the time when the resource was updated.

+

provisioning_state

+

String

+

Specifies the status of a resource operation.

+

state

+

String

+

Resource state. The value can be normal or deleted.

+

tags

+

Map<String,String>

+

Specifies the resource tag.

+

properties

+

Map<String,Object>

+

Specifies the detailed properties of the resource.

+

Resource attributes vary based on different resources. For details about resource attribute parameter description, see the documentation of related services.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 PageInfo

Parameter

+

Type

+

Description

+

current_count

+

Integer

+

Specifies the resource quantity on the current page.

+

Minimum: 0

+

Maximum: 200

+

next_marker

+

String

+

Specifies the marker value of the next page.

+

Minimum: 4

+

Maximum: 400

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "resources": [
+    {
+      "id": "009e9359-70e4-4570-a3a8-69a6c53d5c36",
+      "name": "ecs-aziuzko",
+      "provider": "evs",
+      "type": "volumes",
+      "region_id": "eu-de",
+      "project_id": "ecabfaea4fd6425ba80d6f8860d8847d",
+      "project_name": "eu-de_TSRU",
+      "ep_id": "0",
+      "ep_name": "default",
+      "checksum": "793ebafeb29b2ffdd3df4b018dd9c8e535ea4eba9f19cd6079d7bf998d51c33d",
+      "created": "2022-12-21T14:14:43.811Z",
+      "updated": "2022-12-21T14:14:50.935Z",
+      "provisioning_state": "Succeeded",
+      "state": "Normal",
+      "tags": {},
+      "properties": {
+        "shareable": false,
+        "volumeType": "SAS",
+        "metadata": {
+          "readonly": "False",
+          "attachedMode": "rw"
+        },
+        "attachments": [
+          {
+            "attachedAt": "2022-12-21T14:14:50.879146",
+            "volumeId": "009e9359-70e4-4570-a3a8-69a6c53d5c36",
+            "id": "009e9359-70e4-4570-a3a8-69a6c53d5c36",
+            "attachmentId": "4e84732b-3a7f-43df-9c05-8f5298651ea9",
+            "serverId": "d418cc33-dd14-43f7-aa1e-a72ecab1a9b3",
+            "device": "/dev/vda"
+          }
+        ],
+        "replicationStatus": "disabled",
+        "availabilityZone": "eu-de-01",
+        "bootable": "true",
+        "userId": "e3b5c19edad843e682a6a21a3b950127",
+        "volTenantAttrTenantId": "ecabfaea4fd6425ba80d6f8860d8847d",
+        "size": 6,
+        "encrypted": false,
+        "volumeImageMetadata": {
+          "virtualEnvType": "FusionCompute",
+          "isregistered": "true",
+          "imageSourceType": "uds",
+          "supportXenGpuType": "false",
+          "minDisk": "6",
+          "platform": "Ubuntu",
+          "osVersion": "Ubuntu 22.04 server 64bit",
+          "minRam": "1024",
+          "name": "Standard_Ubuntu_22.04_latest",
+          "checksum": "a1733c9887975ed17d6e4a3131f89ab8",
+          "osBit": "64",
+          "osType": "Linux",
+          "containerFormat": "bare",
+          "supportXen": "true",
+          "id": "e36a291e-5829-470a-9eeb-cb6c31ceddd4",
+          "imageSize": "1246982144",
+          "supportKvm": "true",
+          "diskFormat": "zvhd2",
+          "imageType": "gold"
+        },
+        "volHostAttrHost": "pod01.eu-de-01#1",
+        "multiattach": false,
+        "status": "in-use"
+      }
+    }
+  ],
+  "page_info": {
+    "current_count": 1,
+    "next_marker": "CAESJgokMDA5ZTkzNTktNzBlNC00NTcwLWEzYTgtNjlhNmM1M2Q1YzM2GgTu_7U_"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameter

+

403

+

User authentication failed.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Query
+
+
+ diff --git a/docs/config/api-ref/rms_04_0110.html b/docs/config/api-ref/rms_04_0110.html new file mode 100644 index 00000000..ebe18a4d --- /dev/null +++ b/docs/config/api-ref/rms_04_0110.html @@ -0,0 +1,311 @@ + + +

Querying how many resources are recorded by the resource recorder

+

Function

Querying how many resources are recorded by the resource recorder in the current account

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/tracked-resources/count

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

id

+

No

+

String

+

Specifies the resource ID.

+

Maximum: 512

+

name

+

No

+

String

+

Specifies the resource name.

+

Maximum: 256

+

type

+

No

+

Array

+

Specifies resource types in the format of provider.type.

+

Array Length: 1 - 100

+

region_id

+

No

+

Array

+

Specifies the regions.

+

Array Length: 1 - 10

+

ep_id

+

No

+

Array

+

Specifies enterprise project IDs.

+

Array Length: 1 - 10

+

project_id

+

No

+

Array

+

Specifies the project ID.

+

Array Length: 1 - 10

+

tags

+

No

+

Array

+

Specifies tags. The format is key or key=value.

+

Array Length: 1 - 5

+

resource_deleted

+

No

+

Boolean

+

Indicating whether deleted resources need to be returned. This parameter is set to false by default.

+

Default: false

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

total_count

+

Integer

+

Specifies the total number of resources.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

Querying how many resources are recorded by the resource recorder in the current account

+
GET https://{endpoint}/v1/resource-manager/domains/{domain_id}/tracked-resources/count
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "total_count" : 345
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameter.

+

403

+

User authentication failed.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Query
+
+
+ diff --git a/docs/config/api-ref/rms_04_0111.html b/docs/config/api-ref/rms_04_0111.html new file mode 100644 index 00000000..7b3746d7 --- /dev/null +++ b/docs/config/api-ref/rms_04_0111.html @@ -0,0 +1,340 @@ + + +

Querying resource tags recorded by the resource recorder

+

Function

Querying resource tags recorded by the resource recorder in the current account

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/tracked-resources/tags

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

No

+

String

+

Specifies the name of the tag key.

+

Maximum: 128

+

marker

+

No

+

String

+

Specifies the pagination parameter.

+

Minimum: 4

+

Maximum: 400

+

limit

+

No

+

Integer

+

Specifies the maximum number of resources to return.

+

Minimum: 1

+

Maximum: 200

+

Default: 100

+

resource_deleted

+

No

+

Boolean

+

Indicating whether deleted resources need to be returned. This parameter is set to false by default.

+

Default: false

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

tags

+

Array of TagEntity objects

+

Specifies tags.

+

page_info

+

PageInfo object

+

Specifies the pagination object.

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 TagEntity

Parameter

+

Type

+

Description

+

key

+

String

+

Specifies the tag key.

+

value

+

Array of strings

+

Specifies tag values.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 PageInfo

Parameter

+

Type

+

Description

+

current_count

+

Integer

+

Specifies the resource quantity on the current page.

+

Minimum: 0

+

Maximum: 200

+

next_marker

+

String

+

Specifies the marker value of the next page.

+

Minimum: 4

+

Maximum: 400

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

Querying resource tags recorded by the resource recorder in the current account

+
GET https://{endpoint}/v1/resource-manager/domains/{domain_id}/tracked-resources/tags
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "tags" : [ {
+    "key" : "chloe",
+    "value" : [ "a", "b" ]
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameter.

+

403

+

User authentication failed.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Query
+
+
+ diff --git a/docs/config/api-ref/rms_04_0112.html b/docs/config/api-ref/rms_04_0112.html new file mode 100644 index 00000000..ca852487 --- /dev/null +++ b/docs/config/api-ref/rms_04_0112.html @@ -0,0 +1,386 @@ + + +

Querying resource overview recorded by the resource recorder

+

Function

Querying resource overview recorded by the resource recorder in the current account

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/tracked-resources/summary

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

No

+

String

+

Specifies the resource name.

+

Maximum: 256

+

type

+

No

+

Array

+

Specifies resource types in the format of provider.type.

+

Array Length: 1 - 100

+

region_id

+

No

+

Array

+

Specifies the regions.

+

Array Length: 1 - 10

+

ep_id

+

No

+

Array

+

Specifies enterprise project IDs.

+

Array Length: 1 - 10

+

project_id

+

No

+

Array

+

Specifies the project ID.

+

Array Length: 1 - 10

+

tags

+

No

+

Array

+

Specifies tags. The format is key or key=value.

+

Array Length: 1 - 5

+

resource_deleted

+

No

+

Boolean

+

Indicating whether deleted resources need to be returned. This parameter is set to false by default.

+

Default: false

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

items

+

Array of ResourceSummaryResponseItem objects

+

Specifies the list of resource summary information.

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 ResourceSummaryResponseItem

Parameter

+

Type

+

Description

+

provider

+

String

+

Specifies the cloud service name.

+

types

+

Array of types objects

+

Specifies the resource type list.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 types

Parameter

+

Type

+

Description

+

type

+

String

+

Specifies the resource type.

+

regions

+

Array of regions objects

+

Specifies the regions.

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 regions

Parameter

+

Type

+

Description

+

region_id

+

String

+

Specifies the region ID.

+

count

+

Long

+

Specifies the number of resources of this type in the current region.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

Querying resource overview recorded by the resource recorder in the current account

+
GET https://{endpoint}/v1/resource-manager/domains/{domain_id}/tracked-resources/summary
+
+

Example Responses

Status code: 200

+

Successful Operation

+
[ {
+  "provider" : "ecs",
+  "types" : [ {
+    "type" : "buckets",
+    "regions" : [ {
+      "region_id" : "regionid1",
+      "count" : 5
+    } ]
+  } ]
+} ]
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Successful Operation

+

400

+

Invalid Param Supplied

+

403

+

Authentication Failed

+

500

+

Internal Error

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Query
+
+
+ diff --git a/docs/config/api-ref/rms_04_0113.html b/docs/config/api-ref/rms_04_0113.html new file mode 100644 index 00000000..603d9d2c --- /dev/null +++ b/docs/config/api-ref/rms_04_0113.html @@ -0,0 +1,396 @@ + + +

Querying a specific resource recorded by the resource recorder

+

Function

Querying a specific resource recorded by the resource recorder in the current account

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/tracked-resources/{resource_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+

resource_id

+

Yes

+

String

+

Specifies the resource ID.

+

Maximum: 512

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the resource ID.

+

name

+

String

+

Specifies the resource name.

+

provider

+

String

+

Specifies the cloud service name.

+

type

+

String

+

Specifies the resource type.

+

region_id

+

String

+

Specifies the region ID.

+

project_id

+

String

+

Specifies the project ID in IaaS OpenStack.

+

project_name

+

String

+

Specifies the project name in IaaS OpenStack.

+

ep_id

+

String

+

Specifies the enterprise project ID.

+

ep_name

+

String

+

Specifies the name of an enterprise project.

+

checksum

+

String

+

Specifies the resource checksum.

+

created

+

String

+

Specifies the time when the resource was created.

+

updated

+

String

+

Specifies the time when the resource was updated.

+

provisioning_state

+

String

+

Specifies the status of a resource operation.

+

state

+

String

+

Resource state. The value can be normal or deleted.

+

tags

+

Map<String,String>

+

Specifies the resource tag.

+

properties

+

Map<String,Object>

+

Specifies the detailed properties of the resource.

+

Resource attributes vary based on different resources. For details about resource attribute parameter description, see the documentation of related services.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

Querying a specific resource recorded by the resource recorder in the current account

+
GET https://{endpoint}/v1/resource-manager/domains/{domain_id}/tracked-resources/{resource_id}
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "id": "009e9359-70e4-4570-a3a8-69a6c53d5c36",
+  "name": "ecs-aziuzko",
+  "provider": "evs",
+  "type": "volumes",
+  "region_id": "eu-de",
+  "project_id": "ecabfaea4fd6425ba80d6f8860d8847d",
+  "project_name": "eu-de_TSRU",
+  "ep_id": "0",
+  "ep_name": "default",
+  "checksum": "793ebafeb29b2ffdd3df4b018dd9c8e535ea4eba9f19cd6079d7bf998d51c33d",
+  "created": "2022-12-21T14:14:43.811Z",
+  "updated": "2022-12-21T14:14:50.935Z",
+  "provisioning_state": "Succeeded",
+  "state": "Normal",
+  "tags": {},
+  "properties": {
+    "shareable": false,
+    "volumeType": "SAS",
+    "metadata": {
+      "readonly": "False",
+      "attachedMode": "rw"
+    },
+    "attachments": [
+      {
+        "attachedAt": "2022-12-21T14:14:50.879146",
+        "volumeId": "009e9359-70e4-4570-a3a8-69a6c53d5c36",
+        "id": "009e9359-70e4-4570-a3a8-69a6c53d5c36",
+        "attachmentId": "4e84732b-3a7f-43df-9c05-8f5298651ea9",
+        "serverId": "d418cc33-dd14-43f7-aa1e-a72ecab1a9b3",
+        "device": "/dev/vda"
+      }
+    ],
+    "replicationStatus": "disabled",
+    "availabilityZone": "eu-de-01",
+    "bootable": "true",
+    "userId": "e3b5c19edad843e682a6a21a3b950127",
+    "volTenantAttrTenantId": "ecabfaea4fd6425ba80d6f8860d8847d",
+    "size": 6,
+    "encrypted": false,
+    "volumeImageMetadata": {
+      "virtualEnvType": "FusionCompute",
+      "isregistered": "true",
+      "imageSourceType": "uds",
+      "supportXenGpuType": "false",
+      "minDisk": "6",
+      "platform": "Ubuntu",
+      "osVersion": "Ubuntu 22.04 server 64bit",
+      "minRam": "1024",
+      "name": "Standard_Ubuntu_22.04_latest",
+      "checksum": "a1733c9887975ed17d6e4a3131f89ab8",
+      "osBit": "64",
+      "osType": "Linux",
+      "containerFormat": "bare",
+      "supportXen": "true",
+      "id": "e36a291e-5829-470a-9eeb-cb6c31ceddd4",
+      "imageSize": "1246982144",
+      "supportKvm": "true",
+      "diskFormat": "zvhd2",
+      "imageType": "gold"
+    },
+    "volHostAttrHost": "pod01.eu-de-01#1",
+    "multiattach": false,
+    "status": "in-use"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameter.

+

403

+

User authentication failed.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Query
+
+
+ diff --git a/docs/config/api-ref/rms_04_0200.html b/docs/config/api-ref/rms_04_0200.html new file mode 100644 index 00000000..48a496e2 --- /dev/null +++ b/docs/config/api-ref/rms_04_0200.html @@ -0,0 +1,20 @@ + + +

Resource Recorder

+

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/config/api-ref/rms_04_0201.html b/docs/config/api-ref/rms_04_0201.html new file mode 100644 index 00000000..dce11d36 --- /dev/null +++ b/docs/config/api-ref/rms_04_0201.html @@ -0,0 +1,406 @@ + + +

Querying the Resource Recorder

+

Function

This API is used to query details about the resource recorder.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/tracker-config

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

channel

+

ChannelConfigBody object

+

Specifies configurations for the tracker channel.

+

selector

+

SelectorConfigBody object

+

Specifies the selector.

+

retention_period_in_days

+

Integer

+

Number of days for data storage.

+

agency_name

+

String

+

Specifies the IAM agency name.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 ChannelConfigBody

Parameter

+

Type

+

Description

+

smn

+

TrackerSMNChannelConfigBody object

+

Specifies configurations for the SMN channel. For details about how to grant other accounts the permissions for publishing messages to SMN topics, see Cross-Account Authorization (Resource Recorder > Enabling, Configuring, or Modifying the Resource Recorder) in the User Guide.

+

obs

+

TrackerOBSChannelConfigBody object

+

Specifies configurations for the OBS bucket. For details about how to grant other accounts the permissions for dumping files to OBS buckets, see Cross-Account Authorization (Resource Recorder > Enabling, Configuring, or Modifying the Resource Recorder) in the User Guide.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 TrackerSMNChannelConfigBody

Parameter

+

Type

+

Description

+

region_id

+

String

+

Specifies the region ID.

+

project_id

+

String

+

Specifies the project ID.

+

topic_urn

+

String

+

Specifies the SMN topic URN.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 6 TrackerOBSChannelConfigBody

Parameter

+

Type

+

Description

+

bucket_name

+

String

+

Specifies the OBS bucket name.

+

Maximum: 63

+

bucket_prefix

+

String

+

OBS bucket prefix

+

Maximum: 256

+

region_id

+

String

+

Specifies the region ID.

+
+
+ +
+ + + + + + + + + + + + + +
Table 7 SelectorConfigBody

Parameter

+

Type

+

Description

+

all_supported

+

Boolean

+

Specifies whether to select all supported resources.

+

resource_types

+

Array of strings

+

Specifies the resource type list.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 11 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "channel": {
+    "smn": {
+      "region_id": "eu-de",
+      "project_id": "ecabfaea4fd6425ba80d6f8860d8847d",
+      "topic_urn": "urn:smn:eu-de:ecabfaea4fd6425ba80d6f8860d8847d:obs_testcase"
+    },
+    "obs": {
+      "bucket_name": "resource-dump",
+      "bucket_prefix": null,
+      "region_id": "eu-de"
+    }
+  },
+  "selector": {
+    "all_supported": true,
+    "resource_types": []
+  },
+  "retention_period_in_days": 2557,
+  "agency_name": "rms_tracker_agency"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

Authentication failed or you do not have the operation permissions.

+

404

+

No resource recorder found.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Recorder
+
+
+ diff --git a/docs/config/api-ref/rms_04_0202.html b/docs/config/api-ref/rms_04_0202.html new file mode 100644 index 00000000..cf4d0b14 --- /dev/null +++ b/docs/config/api-ref/rms_04_0202.html @@ -0,0 +1,224 @@ + + +

Deleting the Resource Recorder

+

Function

This API is used to delete the resource recorder.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /v1/resource-manager/domains/{domain_id}/tracker-config

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

None

+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

Authentication failed or you do not have the operation permissions.

+

404

+

No resource recorder found.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Recorder
+
+
+ diff --git a/docs/config/api-ref/rms_04_0203.html b/docs/config/api-ref/rms_04_0203.html new file mode 100644 index 00000000..0b8fbdc8 --- /dev/null +++ b/docs/config/api-ref/rms_04_0203.html @@ -0,0 +1,442 @@ + + +

Creating or Modifying the Resource Recorder

+

Function

This API is used to create or modify the resource recorder. Only one resource recorder can be configured.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /v1/resource-manager/domains/{domain_id}/tracker-config

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

channel

+

Yes

+

ChannelConfigBody object

+

Specifies configurations for the tracker channel.

+

selector

+

Yes

+

SelectorConfigBody object

+

Specifies the selector.

+

retention_period_in_days

+

No

+

Integer

+

Number of days for data storage.

+

agency_name

+

Yes

+

String

+

Specifies the IAM agency name.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 4 ChannelConfigBody

Parameter

+

Mandatory

+

Type

+

Description

+

smn

+

No

+

TrackerSMNChannelConfigBody object

+

Specifies configurations for the SMN channel. For details about how to grant other accounts the permissions for publishing messages to SMN topics, see Cross-Account Authorization (Resource Recorder > Enabling, Configuring, or Modifying the Resource Recorder) in the User Guide.

+

obs

+

No

+

TrackerOBSChannelConfigBody object

+

Specifies configurations for the OBS bucket. For details about how to grant other accounts the permissions for dumping files to OBS buckets, see Cross-Account Authorization (Resource Recorder > Enabling, Configuring, or Modifying the Resource Recorder) in the User Guide.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 5 TrackerSMNChannelConfigBody

Parameter

+

Mandatory

+

Type

+

Description

+

region_id

+

Yes

+

String

+

Specifies the region ID.

+

project_id

+

Yes

+

String

+

Specifies the project ID.

+

topic_urn

+

Yes

+

String

+

Specifies the SMN topic URN.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 6 TrackerOBSChannelConfigBody

Parameter

+

Mandatory

+

Type

+

Description

+

bucket_name

+

Yes

+

String

+

Specifies the OBS bucket name.

+

Maximum: 63

+

bucket_prefix

+

No

+

String

+

OBS bucket prefix

+

Maximum: 256

+

region_id

+

Yes

+

String

+

Specifies the region ID.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 7 SelectorConfigBody

Parameter

+

Mandatory

+

Type

+

Description

+

all_supported

+

Yes

+

Boolean

+

Specifies whether to select all supported resources.

+

resource_types

+

Yes

+

Array of strings

+

Specifies the resource type list.

+
+
+
+

Response Parameters

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 11 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

Creating the resource recorder and enabling message pushing and dumping

+
PUT /v1/resource-manager/domains/{domain_id}/tracker-config
+
+{
+  "channel" : {
+    "smn" : {
+      "region_id" : "regionid1",
+      "project_id" : "39c2af998c334ed6bcbb75b27318f7b5",
+      "topic_urn" : "urn:smn:regionid1:39c2af998c334ed6bcbb75b27318f7b5:resource-manager-test"
+    },
+    "obs" : {
+      "bucket_name" : "config-snapshot",
+      "region_id" : "regionid1"
+    }
+  },
+  "selector" : {
+    "all_supported" : true,
+    "resource_types" : [ ]
+  },
+  "agency_name" : "rms_tracker_agency"
+}
+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

Authentication failed or you do not have the operation permissions.

+

404

+

Resources not found.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Recorder
+
+
+ diff --git a/docs/config/api-ref/rms_04_0300.html b/docs/config/api-ref/rms_04_0300.html new file mode 100644 index 00000000..2bf74d71 --- /dev/null +++ b/docs/config/api-ref/rms_04_0300.html @@ -0,0 +1,16 @@ + + +

Resource Relationships

+

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/config/api-ref/rms_04_0302.html b/docs/config/api-ref/rms_04_0302.html new file mode 100644 index 00000000..654c1ffd --- /dev/null +++ b/docs/config/api-ref/rms_04_0302.html @@ -0,0 +1,412 @@ + + +

Querying Details About Resource Relationships

+

Function

This API is used to query the relationship between a resource and other resources by the resource ID. The relationship direction can be in or out. An IAM user needs to have the rms:resources:getRelation permissions to call this API. Resource relationships depend on enabling resource recorder.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/all-resources/{resource_id}/relations

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+

resource_id

+

Yes

+

String

+

Specifies the resource ID.

+

Maximum: 512

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

direction

+

Yes

+

String

+

Specifies the direction of a resource relationship.

+

limit

+

No

+

Integer

+

Specifies the maximum number of records to return.

+

Minimum: 1

+

Maximum: 1000

+

marker

+

No

+

String

+

Specifies the pagination parameter.

+

Minimum: 4

+

Maximum: 400

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

relations

+

Array of ResourceRelation objects

+

Specifies the list of the resource relationships.

+

page_info

+

PageInfo object

+

Specifies the pagination object.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 ResourceRelation

Parameter

+

Type

+

Description

+

relation_type

+

String

+

Specifies the relationship type.

+

from_resource_type

+

String

+

Specifies the type of the source resource.

+

to_resource_type

+

String

+

Specifies the type of the destination resource.

+

from_resource_id

+

String

+

Specifies the ID of the source resource.

+

to_resource_id

+

String

+

Specifies the ID of the destination resource.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 PageInfo

Parameter

+

Type

+

Description

+

current_count

+

Integer

+

Specifies the resource quantity on the current page.

+

Minimum: 0

+

Maximum: 200

+

next_marker

+

String

+

Specifies the marker value of the next page.

+

Minimum: 4

+

Maximum: 400

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

GET https://{endpoint}/v1/resource-manager/domains/{domain_id}/all-resources/{resource_id}/relations?direction=out
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "relations" : [ {
+    "relation_type" : "isAttachedTo",
+    "from_resource_type" : "ecs.cloudservers",
+    "to_resource_type" : "evs.volumes",
+    "from_resource_id" : "6af96128-d58d-426c-91e0-b38144c0f112",
+    "to_resource_id" : "0075ed19-59dd-49be-961d-117bb6fbfd3e"
+  }, {
+    "relation_type" : "contains",
+    "from_resource_type" : "ecs.cloudservers",
+    "to_resource_type" : "vpc.publicips",
+    "from_resource_id" : "6af96128-d58d-426c-91e0-b38144c0f112",
+    "to_resource_id" : "3813d6d3-ef88-47b1-b343-cdf6390c6dcb"
+  }, {
+    "relation_type" : "isAssociatedWith",
+    "from_resource_type" : "ecs.cloudservers",
+    "to_resource_type" : "vpc.securityGroups",
+    "from_resource_id" : "6af96128-d58d-426c-91e0-b38144c0f112",
+    "to_resource_id" : "8cca3002-00af-4812-a853-b7a6fbee06a4"
+  }, {
+    "relation_type" : "isAttachedTo",
+    "from_resource_type" : "ecs.cloudservers",
+    "to_resource_type" : "evs.volumes",
+    "from_resource_id" : "6af96128-d58d-426c-91e0-b38144c0f112",
+    "to_resource_id" : "f4a107eb-4c6d-4dc8-88d8-de337923956f"
+  }, {
+    "relation_type" : "isContainedIn",
+    "from_resource_type" : "ecs.cloudservers",
+    "to_resource_type" : "vpc.vpcs",
+    "from_resource_id" : "6af96128-d58d-426c-91e0-b38144c0f112",
+    "to_resource_id" : "ff13d70d-17e5-4ec8-945a-c874e0db99d3"
+  } ],
+  "page_info" : {
+    "current_count" : 5,
+    "next_marker" : null
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

User authentication failed.

+

404

+

Resources not found.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Relationships
+
+
+ diff --git a/docs/config/api-ref/rms_04_0400.html b/docs/config/api-ref/rms_04_0400.html new file mode 100644 index 00000000..14758abc --- /dev/null +++ b/docs/config/api-ref/rms_04_0400.html @@ -0,0 +1,16 @@ + + +

Resource Change Records

+

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/config/api-ref/rms_04_0401.html b/docs/config/api-ref/rms_04_0401.html new file mode 100644 index 00000000..3bb5e848 --- /dev/null +++ b/docs/config/api-ref/rms_04_0401.html @@ -0,0 +1,760 @@ + + +

Querying Change Records of a Resource

+

Function

This API is used to query change records of a resource and its relationships with other resources.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/resources/{resource_id}/history

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+

resource_id

+

Yes

+

String

+

Specifies the resource ID.

+

Maximum: 512

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

marker

+

No

+

String

+

Specifies the pagination parameter.

+

Minimum: 4

+

Maximum: 400

+

limit

+

No

+

Integer

+

Specifies the maximum number of records to return.

+

Minimum: 1

+

Maximum: 200

+

Default: 200

+

earlier_time

+

No

+

Long

+

Specifies the start time of the query. If this parameter is not set, the earliest time is used by default.

+

later_time

+

No

+

Long

+

Specifies the end time of the query. If this parameter is not set, the current time is used by default.

+

chronological_order

+

No

+

String

+

Specifies the time sequence of the data to be returned. The default value is Reverse.

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

items

+

Array of HistoryItem objects

+

Specifies the list of resource history.

+

page_info

+

PageInfo object

+

Specifies the pagination object.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 HistoryItem

Parameter

+

Type

+

Description

+

domain_id

+

String

+

Specifies the user ID.

+

resource_id

+

String

+

Specifies the resource ID.

+

resource_type

+

String

+

Specifies the resource type.

+

capture_time

+

String

+

Specifies the time when the resource was captured.

+

status

+

String

+

Specifies the resource status.

+

relations

+

Array of ResourceRelation objects

+

Specifies the list of the resource relationships.

+

resource

+

ResourceEntity object

+

Specifies the resource object.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 ResourceRelation

Parameter

+

Type

+

Description

+

relation_type

+

String

+

Specifies the relationship type.

+

from_resource_type

+

String

+

Specifies the type of the source resource.

+

to_resource_type

+

String

+

Specifies the type of the destination resource.

+

from_resource_id

+

String

+

Specifies the ID of the source resource.

+

to_resource_id

+

String

+

Specifies the ID of the destination resource.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 7 ResourceEntity

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the resource ID.

+

name

+

String

+

Specifies the resource name.

+

provider

+

String

+

Specifies the cloud service name.

+

type

+

String

+

Specifies the resource type.

+

region_id

+

String

+

Specifies the region ID.

+

project_id

+

String

+

Specifies the project ID in IaaS OpenStack.

+

project_name

+

String

+

Specifies the project name in IaaS OpenStack.

+

ep_id

+

String

+

Specifies the enterprise project ID.

+

ep_name

+

String

+

Specifies the name of an enterprise project.

+

checksum

+

String

+

Specifies the resource checksum.

+

created

+

String

+

Specifies the time when the resource was created.

+

updated

+

String

+

Specifies the time when the resource was updated.

+

provisioning_state

+

String

+

Specifies the status of a resource operation.

+

state

+

String

+

Resource state. The value can be normal or deleted.

+

tags

+

Map<String,String>

+

Specifies the resource tag.

+

properties

+

Map<String,Object>

+

Specifies the detailed properties of the resource.

+

Resource attributes vary based on different resources. For details about resource attribute parameter description, see the documentation of related services.

+

osType

+

String

+

Specifies the OS type of the cloud server. The value can be Linux or Windows.

+

keyName

+

String

+

Specifies the key pair that is used to authenticate an ECS.

+

schedulerHints

+

Object

+

Specifies the ECS scheduling information.

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 8 Description of some key ECS attributes

Parameter

+

Type

+

Description

+

osType

+

String

+

Specifies the OS type. The value can be Linux or Windows.

+

keyName

+

String

+

Specifies the key pair that is used to authenticate an ECS.

+

schedulerHints

+

Object

+

Specifies the ECS scheduling information.

+
+
+ +
+ + + + + + + + + + + + + +
Table 9 PageInfo

Parameter

+

Type

+

Description

+

current_count

+

Integer

+

Specifies the resource quantity on the current page.

+

Minimum: 0

+

Maximum: 200

+

next_marker

+

String

+

Specifies the marker value of the next page.

+

Minimum: 4

+

Maximum: 400

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 11 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 12 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

GET /v1/resource-manager/domains/{domain_id}/resources/{resource_id}/history?earlier_time=1595865600000&later_time=1603875761000&limit=10
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "items": [
+   {
+    "domain_id": "daf2557fc0de4da09e128441baa71697",
+    "resource_id": "d418cc33-dd14-43f7-aa1e-a72ecab1a9b3",
+    "resource_type": "ecs.cloudservers",
+    "capture_time": "2024-01-30T11:51:30.029Z",
+    "status": "ResourceChanged.CREATE",
+    "relations": [
+     {
+      "relation_type": "isAttachedTo",
+      "from_resource_type": "ecs.cloudservers",
+      "to_resource_type": "vpc.publicips",
+      "from_resource_id": "d418cc33-dd14-43f7-aa1e-a72ecab1a9b3",
+      "to_resource_id": "f1c02dc1-0127-434d-ab87-7ed623e0229b"
+     },
+     {
+      "relation_type": "isAttachedTo",
+      "from_resource_type": "ecs.cloudservers",
+      "to_resource_type": "evs.volumes",
+      "from_resource_id": "d418cc33-dd14-43f7-aa1e-a72ecab1a9b3",
+      "to_resource_id": "009e9359-70e4-4570-a3a8-69a6c53d5c36"
+     },
+     {
+      "relation_type": "isContainedIn",
+      "from_resource_type": "ecs.cloudservers",
+      "to_resource_type": "vpc.vpcs",
+      "from_resource_id": "d418cc33-dd14-43f7-aa1e-a72ecab1a9b3",
+      "to_resource_id": "574967f6-17f0-49f2-bec0-ecc6736b2d8b"
+     },
+     {
+      "relation_type": "isAssociatedWith",
+      "from_resource_type": "ecs.cloudservers",
+      "to_resource_type": "vpc.securityGroups",
+      "from_resource_id": "d418cc33-dd14-43f7-aa1e-a72ecab1a9b3",
+      "to_resource_id": "c33525f6-e38b-4c92-8ad6-c12453e3123c"
+     }
+    ],
+    "resource": {
+     "id": "d418cc33-dd14-43f7-aa1e-a72ecab1a9b3",
+     "name": "ecs-aziuzko",
+     "provider": "ecs",
+     "type": "cloudservers",
+     "region_id": "eu-de",
+     "project_id": "ecabfaea4fd6425ba80d6f8860d8847d",
+     "project_name": "eu-de_TSRU",
+     "ep_id": "0",
+     "ep_name": "default",
+     "checksum": "7ad9076c6d08decd7185d271e45e8908c3901a732f2a19fc4429e54cf9b58029",
+     "created": "2022-12-21T14:14:41Z",
+     "updated": "2024-01-30T11:51:24Z",
+     "provisioning_state": "Succeeded",
+     "state": null,
+     "tags": {},
+     "properties": {
+      "accessIpv4": "",
+      "hostName": "ecs-aziuzko",
+      "addresses": [
+       {
+        "OsExtIpsType": "fixed",
+        "OsExtIpsPortId": "0aa69070-db1e-45b6-92cc-834094a11205",
+        "addr": "192.168.0.60",
+        "version": 4,
+        "OsExtIpsMacAddr": "fa:16:3e:13:6a:a6"
+       },
+       {
+        "OsExtIpsType": "floating",
+        "OsExtIpsPortId": "0aa69070-db1e-45b6-92cc-834094a11205",
+        "addr": "80.158.1.160",
+        "version": 4,
+        "OsExtIpsMacAddr": "fa:16:3e:13:6a:a6"
+       }
+      ],
+      "accessIpv6": "",
+      "metadata": {
+       "chargingMode": "0",
+       "meteringImageType": "gold",
+       "imageName": "Standard_Ubuntu_22.04_latest",
+       "meteringImageId": "e36a291e-5829-470a-9eeb-cb6c31ceddd4",
+       "meteringResourcesPerCode": "s2.medium.1.linux",
+       "vpcId": "574967f6-17f0-49f2-bec0-ecc6736b2d8b",
+       "osBit": "64",
+       "osType": "Linux"
+      },
+      "OsExtStsVmState": "active",
+      "configDrive": "",
+      "OsExtStsPowerState": 1,
+      "keyName": "KeyPair-aziuzko",
+      "hostId": "0734968b9c1964107d56ba088571a7cb0f2ec7287f2f1d63632e3efb",
+      "securityGroup": [
+       {
+        "name": "default",
+        "id": "c33525f6-e38b-4c92-8ad6-c12453e3123c"
+       }
+      ],
+      "ExtVolumesAttached": [
+       {
+        "bootIndex": "0",
+        "id": "009e9359-70e4-4570-a3a8-69a6c53d5c36",
+        "device": "/dev/vda"
+       }
+      ],
+      "userId": "e3b5c19edad843e682a6a21a3b950127",
+      "flavor": {
+       "disk": "0",
+       "name": "s2.medium.1",
+       "id": "s2.medium.1",
+       "vcpus": "1",
+       "ram": "1024"
+      },
+      "osextsrvattr": {
+       "hostName": "ecs-aziuzko",
+       "kernelId": "",
+       "ramdiskId": "",
+       "reservationId": "r-t09j8st1",
+       "instanceName": "instance-003bddff",
+       "host": "734968b9c1964107d56ba088571a7cb0f2ec7287f2f1d63632e3efb",
+       "rootDeviceName": "/dev/vda",
+       "hypervisorHostName": "804f5144c8aac87590118896ba9aa6068d902e3b8f96a4d3f9e2fa0b",
+       "launchIndex": 0
+      },
+      "OsDcfDiskConfig": "MANUAL",
+      "hostStatus": "UP",
+      "OsSrvUsgLaunchedAt": "2022-12-21T14:14:55.000000",
+      "OsExtAz": "eu-de-01",
+      "progress": 0,
+      "locked": false,
+      "OS-EXT-SRV-ATTR": {
+       "hostName": "ecs-aziuzko",
+       "kernelId": "",
+       "ramdiskId": "",
+       "reservationId": "r-t09j8st1",
+       "instanceName": "instance-003bddff",
+       "host": "734968b9c1964107d56ba088571a7cb0f2ec7287f2f1d63632e3efb",
+       "rootDeviceName": "/dev/vda",
+       "hypervisorHostName": "804f5144c8aac87590118896ba9aa6068d902e3b8f96a4d3f9e2fa0b",
+       "launchIndex": 0
+      },
+      "status": "ACTIVE",
+      "schedulerHints": {}
+     }
+    }
+   }
+  ],
+  "page_info": {
+   "current_count": 1,
+   "next_marker": null
+  }
+ }
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

User authentication failed.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Resource Change Records
+
+
+ diff --git a/docs/config/api-ref/rms_04_0500.html b/docs/config/api-ref/rms_04_0500.html new file mode 100644 index 00000000..548bb23d --- /dev/null +++ b/docs/config/api-ref/rms_04_0500.html @@ -0,0 +1,44 @@ + + +

Compliance

+

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/config/api-ref/rms_04_0501.html b/docs/config/api-ref/rms_04_0501.html new file mode 100644 index 00000000..cbca28bb --- /dev/null +++ b/docs/config/api-ref/rms_04_0501.html @@ -0,0 +1,527 @@ + + +

Querying All Built-in Policies

+

Function

This API is used to query all built-in policies.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/policy-definitions

+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + +
Table 1 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Language

+

No

+

String

+

Language of the returned message.

+

Default: en-us

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 2 Response body parameters

Parameter

+

Type

+

Description

+

value

+

Array of PolicyDefinition objects

+

Specifies the policy definition list.

+

page_info

+

PageInfo object

+

Specifies the pagination object.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 PolicyDefinition

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the policy ID.

+

name

+

String

+

Specifies the policy name.

+

display_name

+

String

+

Specifies the policy display name.

+

policy_type

+

String

+

Specifies the policy type.

+

description

+

String

+

Specifies the description of the policy definition.

+

policy_rule_type

+

String

+

Specifies the syntax type of the policy.

+

policy_rule

+

Object

+

Specifies the policy rule.

+

trigger_type

+

String

+

Specifies the trigger type. The value can be resource or period.

+

keywords

+

Array of strings

+

Specifies keywords.

+

default_resource_types

+

Array of default_resource_types objects

+

Specifies the list of default resource types.

+

parameters

+

Map<String,PolicyParameterDefinition>

+

Specifies the policy parameter.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 default_resource_types

Parameter

+

Type

+

Description

+

provider

+

String

+

Specifies the cloud service name.

+

type

+

String

+

Specifies the resource type.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 PolicyParameterDefinition

Parameter

+

Type

+

Description

+

name

+

String

+

Specifies the name of the policy parameter.

+

description

+

String

+

Specifies the description of the policy parameter.

+

allowed_values

+

Array of objects

+

Specifies the allowed values of the policy parameter.

+

default_value

+

String

+

Specifies the default value of the policy parameter.

+

minimum

+

Float

+

Specifies the minimum value of the policy parameter.

+

maximum

+

Float

+

Specifies the maximum value of the policy parameter.

+

min_items

+

Integer

+

Specifies the minimum number of the policy parameter.

+

max_items

+

Integer

+

Specifies the maximum number of the policy parameter.

+

min_length

+

Integer

+

Specifies the minimum string length for policy parameters or for each item.

+

max_length

+

Integer

+

Specifies the maximum string length for policy parameters or for each item.

+

pattern

+

String

+

Specifies the pattern for policy parameters or for each item.

+

type

+

String

+

Specifies the type of the policy parameter.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 PageInfo

Parameter

+

Type

+

Description

+

current_count

+

Integer

+

Specifies the resource quantity on the current page.

+

Minimum: 0

+

Maximum: 200

+

next_marker

+

String

+

Specifies the marker value of the next page.

+

Minimum: 4

+

Maximum: 400

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

GET https://{endpoint}/v1/resource-manager/policy-definitions
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "value" : [ {
+    "id" : "5fa365476eed194ccb2c04d1",
+    "name" : "volumes-encrypted-check",
+    "display_name" : "Enable encryption for the attached EVS volumes.",
+    "policy_type" : "builtin",
+    "description" : "An EVS disk is non-compliant if it has been mounted but not encrypted.",
+    "policy_rule_type" : "dsl",
+    "policy_rule" : {
+      "allOf" : [ {
+        "value" : "${resource().provider}",
+        "comparator" : "equals",
+        "pattern" : "evs"
+      }, {
+        "value" : "${resource().type}",
+        "comparator" : "equals",
+        "pattern" : "volumes"
+      }, {
+        "value" : "${resource().properties.status}",
+        "comparator" : "equals",
+        "pattern" : "in-use"
+      }, {
+        "anyOf" : [ {
+          "value" : "${resource().properties.metadata}",
+          "comparator" : "notContainsKey",
+          "pattern" : "systemEncrypted"
+        }, {
+          "value" : "${resource().properties.metadata.systemEncrypted}",
+          "comparator" : "equals",
+          "pattern" : "0"
+        } ]
+      } ]
+    },
+    "keywords" : [ "evs", "ecs" ],
+    "parameters" : { }
+  } ],
+  "page_info" : {
+    "current_count" : 1,
+    "next_marker" : null
+  }
+}
+

allOf and anyOf in the response example are logical operators. The following describes these two operators in detail:

+

allOf evaluates true only if all included conditions are true, and evaluates false as long as one included condition is false.

+

anyOf evaluates true as long as one included condition is true, and evaluates false if all included conditions are false.

+

allOf and anyOf both implement short-circuit evaluation. They evaluate the conditions in the subsequent list in sequence.

+

If the return result of a condition is false, allOf returns false and the subsequent conditions are not calculated.

+

If the return result of a condition is true, anyOf returns true and the subsequent conditions are not calculated.

+
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameter.

+

403

+

Authentication failed or you do not have the operation permissions.

+

404

+

Resources not found.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Compliance
+
+
+ diff --git a/docs/config/api-ref/rms_04_0502.html b/docs/config/api-ref/rms_04_0502.html new file mode 100644 index 00000000..3dc0efd1 --- /dev/null +++ b/docs/config/api-ref/rms_04_0502.html @@ -0,0 +1,546 @@ + + +

Querying a Built-in Policy

+

Function

This API is used to query a built-in policy based on the policy ID.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/policy-definitions/{policy_definition_id}

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

policy_definition_id

+

Yes

+

String

+

Specifies the policy ID.

+

Maximum: 36

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Language

+

No

+

String

+

Language of the returned message.

+

Default: en-us

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

Specifies the policy ID.

+

name

+

String

+

Specifies the policy name.

+

display_name

+

String

+

Specifies the policy display name.

+

policy_type

+

String

+

Specifies the policy type.

+

description

+

String

+

Specifies the description of the policy definition.

+

policy_rule_type

+

String

+

Specifies the syntax type of the policy.

+

policy_rule

+

Object

+

Specifies the policy rule.

+

trigger_type

+

String

+

Specifies the trigger type. The value can be resource or period.

+

keywords

+

Array of strings

+

Specifies keywords.

+

default_resource_types

+

Array of default_resource_types objects

+

Specifies the list of default resource types.

+

parameters

+

Map<String,PolicyParameterDefinition>

+

Specifies the policy parameter.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 default_resource_types

Parameter

+

Type

+

Description

+

provider

+

String

+

Specifies the cloud service name.

+

type

+

String

+

Specifies the resource type.

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 Parameter description of the example policy

Parameter

+

Type

+

Description

+

specifiedTagKey

+

String

+

Indicates the tag key.

+

specifiedTagValue

+

Array

+

Indicates tag values. If the value list is left empty, all values are allowed.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 PolicyParameterDefinition

Parameter

+

Type

+

Description

+

name

+

String

+

Specifies the name of the policy parameter.

+

description

+

String

+

Specifies the description of the policy parameter.

+

allowed_values

+

Array of objects

+

Specifies the allowed values of the policy parameter.

+

default_value

+

String

+

Specifies the default value of the policy parameter.

+

minimum

+

Float

+

Specifies the minimum value of the policy parameter.

+

maximum

+

Float

+

Specifies the maximum value of the policy parameter.

+

min_items

+

Integer

+

Specifies the minimum number of the policy parameter.

+

max_items

+

Integer

+

Specifies the maximum number of the policy parameter.

+

min_length

+

Integer

+

Specifies the minimum string length for policy parameters or for each item.

+

max_length

+

Integer

+

Specifies the maximum string length for policy parameters or for each item.

+

pattern

+

String

+

Specifies the pattern for policy parameters or for each item.

+

type

+

String

+

Specifies the type of the policy parameter.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

GET https://{endpoint}/v1/resource-manager/policy-definitions/5f8d5428ffeecc14f1fb5205
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "id": "5fa9f89b6eed194ccb2c04db",
+  "name": "required-tag-check",
+  "display_name": "required-tag-check",
+  "policy_type": "builtin",
+  "description": "If a resource is not attached with the specified tag, this resource is considered noncompliant.",
+  "policy_rule_type": "dsl",
+  "policy_rule": {
+    "anyOf": [
+      {
+        "value": "${contains(resource().tags, parameters('specifiedTagKey'))}",
+        "comparator": "equals",
+        "pattern": false
+      },
+      {
+        "allOf": [
+          {
+            "value": "${length(parameters('specifiedTagValue'))}",
+            "comparator": "greater",
+            "pattern": 0
+          },
+          {
+            "value": "${getValue(resource().tags, parameters('specifiedTagKey'))}",
+            "comparator": "notIn",
+            "pattern": "${parameters('specifiedTagValue')}"
+          }
+        ]
+      }
+    ]
+  },
+  "trigger_type": "resource",
+  "keywords": [
+    "tag"
+  ],
+  "default_resource_types": [],
+  "parameters": {
+    "specifiedTagKey": {
+      "name": null,
+      "description": "The specified tag key.",
+      "allowed_values": null,
+      "default_value": null,
+      "minimum": null,
+      "maximum": null,
+      "min_items": null,
+      "max_items": null,
+      "min_length": 1,
+      "max_length": 128,
+      "pattern": null,
+      "type": "String"
+    },
+    "specifiedTagValue": {
+      "name": null,
+      "description": "The list of allowed tag value, permit all if empty.",
+      "allowed_values": null,
+      "default_value": null,
+      "minimum": null,
+      "maximum": null,
+      "min_items": 0,
+      "max_items": 40,
+      "min_length": 0,
+      "max_length": 255,
+      "pattern": null,
+      "type": "Array"
+    }
+  }
+}
+

allOf and anyOf in the response example are logical operators. The following describes these two operators in detail:

+

allOf evaluates true only if all included conditions are true, and evaluates false as long as one included condition is false.

+

anyOf evaluates true as long as one included condition is true, and evaluates false if all included conditions are false.

+

allOf and anyOf both implement short-circuit evaluation. They evaluate the conditions in the subsequent list in sequence.

+

If the return result of a condition is false, allOf returns false and the subsequent conditions are not calculated.

+

If the return result of a condition is true, anyOf returns true and the subsequent conditions are not calculated.

+
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

Authentication failed or you do not have the operation permissions.

+

404

+

Policy not found.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Compliance
+
+
+ diff --git a/docs/config/api-ref/rms_04_0503.html b/docs/config/api-ref/rms_04_0503.html new file mode 100644 index 00000000..a51cf578 --- /dev/null +++ b/docs/config/api-ref/rms_04_0503.html @@ -0,0 +1,789 @@ + + +

Adding a Rule

+

Function

This API is used to add a rule.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /v1/resource-manager/domains/{domain_id}/policy-assignments

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

policy_assignment_type

+

No

+

String

+

Specifies the rule type. A rule type can be custom or builtin. If this parameter is not configured, builtin is used by default.

+

name

+

Yes

+

String

+

Specifies the rule name.

+

Maximum: 64

+

description

+

No

+

String

+

Specifies the rule description.

+

Maximum: 512

+

period

+

No

+

String

+

Specifies the trigger period.

+

You need to set this parameter when trigger type is set to periodic execution.

+

policy_filter

+

No

+

PolicyFilterDefinition object

+

Specifies the policy filter of a rule.

+

You need to set this parameter when trigger type is set to configuration change.

+

policy_definition_id

+

No

+

String

+

Specifies the policy definition ID.

+

To add a rule with a predefined policy, you need to set this parameter.

+

Maximum: 36

+

custom_policy

+

No

+

CustomPolicy object

+

Specifies the custom rule.

+

To create a custom rule, you need to set this parameter.

+

parameters

+

No

+

Map<String,PolicyParameterValue>

+

Specifies the rule parameters.

+

tags

+

No

+

Array of ResourceTag objects

+

Tags

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 PolicyFilterDefinition

Parameter

+

Mandatory

+

Type

+

Description

+

region_id

+

No

+

String

+

Specifies the region ID.

+

Maximum: 128

+

resource_provider

+

No

+

String

+

Specifies the cloud service name.

+

Maximum: 128

+

resource_type

+

No

+

String

+

Specifies the resource type.

+

Maximum: 128

+

resource_id

+

No

+

String

+

Specifies the resource ID.

+

Maximum: 512

+

tag_key

+

No

+

String

+

Specifies the tag key.

+

Maximum: 128

+

tag_value

+

No

+

String

+

Specifies the tag value.

+

Maximum: 256

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 5 CustomPolicy

Parameter

+

Mandatory

+

Type

+

Description

+

function_urn

+

Yes

+

String

+

Specifies the URN of a custom function.

+

Maximum: 1024

+

auth_type

+

Yes

+

String

+

Specifies how function is called by a custom rule.

+

auth_value

+

No

+

Map<String,Object>

+

Specifies the parameter value for invoking a function by a custom rule.

+
+
+ +
+ + + + + + + + + + + +
Table 6 PolicyParameterValue

Parameter

+

Mandatory

+

Type

+

Description

+

value

+

No

+

Object

+

Specifies the value of the rule parameter.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 7 ResourceTag

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Tag key. A tag key can contain up to 128 Unicode characters and must complay with the character set specifications in section 3.1.

+

Minimum: 1

+

Maximum: 128

+

value

+

Yes

+

String

+

Tag value. A tag value can contain up to 255 Unicode characters and must comply with the character set specifications in section 3.2.

+

Minimum: 0

+

Maximum: 255

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

policy_assignment_type

+

String

+

Specifies the rule type, which can be builtin or custom.

+

id

+

String

+

Specifies the rule ID.

+

name

+

String

+

Specifies the rule name.

+

description

+

String

+

Specifies the rule description.

+

policy_filter

+

PolicyFilterDefinition object

+

Specifies the policy filter of a rule.

+

period

+

String

+

Specifies how often the rule is triggered, which can be One_Hour, Three_Hours, Six_Hours, Twelve_Hours, or TwentyFour_Hours.

+

state

+

String

+

Specifies the rule status.

+

created

+

String

+

Specifies the time when the rule was added.

+

updated

+

String

+

Specifies the time when the rule was modified.

+

policy_definition_id

+

String

+

Specifies the ID of the policy used by the rule.

+

custom_policy

+

CustomPolicy object

+

Specifies the custom rule.

+

parameters

+

Map<String,PolicyParameterValue>

+

Specifies the rule parameters.

+

tags

+

Array of ResourceTag objects

+

Tags

+

created_by

+

String

+

Specifies the person who created the rule.

+

target_type

+

String

+

traget_type is reserved for new features usage. In current version the result is null.

+

target_id

+

String

+

target_id is reserved for new features usage. In current version the result is null.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 9 PolicyFilterDefinition

Parameter

+

Type

+

Description

+

region_id

+

String

+

Specifies the region ID.

+

Maximum: 128

+

resource_provider

+

String

+

Specifies the cloud service name.

+

Maximum: 128

+

resource_type

+

String

+

Specifies the resource type.

+

Maximum: 128

+

resource_id

+

String

+

Specifies the resource ID.

+

Maximum: 512

+

tag_key

+

String

+

Specifies the tag key.

+

Maximum: 128

+

tag_value

+

String

+

Specifies the tag value.

+

Maximum: 256

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 10 CustomPolicy

Parameter

+

Type

+

Description

+

function_urn

+

String

+

Specifies the URN of a custom function.

+

Maximum: 1024

+

auth_type

+

String

+

Specifies how function is called by a custom rule.

+

auth_value

+

Map<String,Object>

+

Specifies the parameter value for invoking a function by a custom rule.

+
+
+ +
+ + + + + + + + + +
Table 11 PolicyParameterValue

Parameter

+

Type

+

Description

+

value

+

Object

+

Specifies the value of the rule parameter.

+
+
+ +
+ + + + + + + + + + + + + +
Table 12 ResourceTag

Parameter

+

Type

+

Description

+

key

+

String

+

Tag key. A tag key can contain up to 128 Unicode characters and must complay with the character set specifications in section 3.1.

+

Minimum: 1

+

Maximum: 128

+

value

+

String

+

Tag value. A tag value can contain up to 255 Unicode characters and must comply with the character set specifications in section 3.2.

+

Minimum: 0

+

Maximum: 255

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 13 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 14 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 15 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

Create a rule named "allowed-images-by-id".

+
PUT https://{endpoint}/v1/resource-manager/domains/{domain_id}/policy-assignments
+
+{
+  "name" : "allowed-images-by-id",
+  "description" : "The ECS resource is non-compliant if the image it used is not in the allowed list",
+  "parameters" : {
+    "listOfAllowedImages" : {
+      "value" : [ "ea0d6e0e-99c3-406d-a873-3bb45462b624" ]
+    }
+  },
+  "policy_filter" : {
+    "resource_provider" : "ecs",
+    "resource_type" : "cloudservers"
+  },
+  "policy_definition_id" : "5fa265c0aa1e6afc05a0ff07",
+  "tag" : [ {
+    "key" : "tagkey",
+    "value" : "tagValue"
+  } ]
+}
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+ "policy_assignment_type": "builtin",
+ "id": "66c486e8d58ed9173f4560ac",
+ "name": "allowed-images-by-id",
+ "description": "The ECS resource is non-compliant if the image it used is not in the allowed list",
+ "policy_filter": {
+  "region_id": null,
+  "resource_provider": "ecs",
+  "resource_type": "cloudservers",
+  "resource_id": null,
+  "tag_key": null,
+  "tag_value": null
+ },
+ "period": null,
+ "state": "Enabled",
+ "created": "2024-08-20T12:07:04.763Z",
+ "updated": "2024-08-20T12:07:04.763Z",
+ "policy_definition_id": "5fa265c0aa1e6afc05a0ff07",
+ "custom_policy": null,
+ "parameters": {
+  "listOfAllowedImages": {
+   "value": [
+    "ea0d6e0e-99c3-406d-a873-3bb45462b624"
+   ]
+  }
+ },
+ "tags": [],
+ "created_by": "custom",
+ "target_type": null,
+ "target_id": null
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

Authentication failed or you do not have the operation permissions.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Compliance
+
+
+ diff --git a/docs/config/api-ref/rms_04_0504.html b/docs/config/api-ref/rms_04_0504.html new file mode 100644 index 00000000..a6fe4fc7 --- /dev/null +++ b/docs/config/api-ref/rms_04_0504.html @@ -0,0 +1,630 @@ + + +

Querying All Rules

+

Function

This API is used to query all rules.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/policy-assignments

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

policy_assignment_name

+

No

+

String

+

Specifies the assignment name.

+

Maximum: 64

+

limit

+

No

+

Integer

+

Specifies the maximum number of records to return.

+

Minimum: 1

+

Maximum: 500

+

Default: 500

+

marker

+

No

+

String

+

Specifies the pagination parameter.

+

Minimum: 4

+

Maximum: 400

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

value

+

Array of PolicyAssignment objects

+

Specifies rules.

+

page_info

+

PageInfo object

+

Specifies the pagination object.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 PolicyAssignment

Parameter

+

Type

+

Description

+

policy_assignment_type

+

String

+

Specifies the rule type, which can be builtin or custom.

+

id

+

String

+

Specifies the rule ID.

+

name

+

String

+

Specifies the rule name.

+

description

+

String

+

Specifies the rule description.

+

policy_filter

+

PolicyFilterDefinition object

+

Specifies the policy filter of a rule.

+

period

+

String

+

Specifies how often the rule is triggered, which can be One_Hour, Three_Hours, Six_Hours, Twelve_Hours, or TwentyFour_Hours.

+

state

+

String

+

Specifies the rule status.

+

created

+

String

+

Specifies the time when the rule was added.

+

updated

+

String

+

Specifies the time when the rule was modified.

+

policy_definition_id

+

String

+

Specifies the ID of the policy used by the rule.

+

custom_policy

+

CustomPolicy object

+

Specifies the custom rule.

+

parameters

+

Map<String,PolicyParameterValue>

+

Specifies the rule parameters.

+

tags

+

Array of ResourceTag objects

+

Tags

+

created_by

+

String

+

Specifies the person who created the rule.

+

target_type

+

String

+

traget_type is reserved for new features usage. In current version the result is null.

+

target_id

+

String

+

target_id is reserved for new features usage. In current version the result is null.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 6 PolicyFilterDefinition

Parameter

+

Type

+

Description

+

region_id

+

String

+

Specifies the region ID.

+

Maximum: 128

+

resource_provider

+

String

+

Specifies the cloud service name.

+

Maximum: 128

+

resource_type

+

String

+

Specifies the resource type.

+

Maximum: 128

+

resource_id

+

String

+

Specifies the resource ID.

+

Maximum: 512

+

tag_key

+

String

+

Specifies the tag key.

+

Maximum: 128

+

tag_value

+

String

+

Specifies the tag value.

+

Maximum: 256

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 7 CustomPolicy

Parameter

+

Type

+

Description

+

function_urn

+

String

+

Specifies the URN of a custom function.

+

Maximum: 1024

+

auth_type

+

String

+

Specifies how function is called by a custom rule.

+

auth_value

+

Map<String,Object>

+

Specifies the parameter value for invoking a function by a custom rule.

+
+
+ +
+ + + + + + + + + +
Table 8 PolicyParameterValue

Parameter

+

Type

+

Description

+

value

+

Object

+

Specifies the value of the rule parameter.

+
+
+ +
+ + + + + + + + + + + + + +
Table 9 ResourceTag

Parameter

+

Type

+

Description

+

key

+

String

+

Tag key. A tag key can contain up to 128 Unicode characters and must complay with the character set specifications in section 3.1.

+

Minimum: 1

+

Maximum: 128

+

value

+

String

+

Tag value. A tag value can contain up to 255 Unicode characters and must comply with the character set specifications in section 3.2.

+

Minimum: 0

+

Maximum: 255

+
+
+ +
+ + + + + + + + + + + + + +
Table 10 PageInfo

Parameter

+

Type

+

Description

+

current_count

+

Integer

+

Specifies the resource quantity on the current page.

+

Minimum: 0

+

Maximum: 200

+

next_marker

+

String

+

Specifies the marker value of the next page.

+

Minimum: 4

+

Maximum: 400

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 11 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 12 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 13 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "value": [
+    {
+      "policy_assignment_type": "builtin",
+      "id": "6672d6b0354ba95beef328d1",
+      "name": "allowed-ecs-flavors",
+      "description": "An ECS is noncompliant if its flavor is not in the specified flavor list.",
+      "policy_filter": {
+        "region_id": null,
+        "resource_provider": "ecs",
+        "resource_type": "cloudservers",
+        "resource_id": null,
+        "tag_key": null,
+        "tag_value": null
+      },
+      "period": null,
+      "state": "Enabled",
+      "created": "2024-06-19T13:01:36.397Z",
+      "updated": "2024-06-19T13:01:36.397Z",
+      "policy_definition_id": "5f8d549bffeecc14f1fb522a",
+      "custom_policy": null,
+      "parameters": {
+        "listOfAllowedFlavors": {
+          "value": []
+        }
+      },
+      "tags": [],
+      "created_by": "custom",
+      "target_type": null,
+      "target_id": null
+    },
+    {
+      "policy_assignment_type": "builtin",
+      "id": "6672d83777c56f4aeb50b892",
+      "name": "allowed-ecs-flavorss",
+      "description": "An ECS is noncompliant if its flavor is not in the specified flavor list.",
+      "policy_filter": {
+        "region_id": null,
+        "resource_provider": "ecs",
+        "resource_type": "cloudservers",
+        "resource_id": null,
+        "tag_key": null,
+        "tag_value": null
+      },
+      "period": null,
+      "state": "Enabled",
+      "created": "2024-06-19T13:08:07.771Z",
+      "updated": "2024-06-19T13:08:07.771Z",
+      "policy_definition_id": "5f8d549bffeecc14f1fb522a",
+      "custom_policy": null,
+      "parameters": {
+        "listOfAllowedFlavors": {
+          "value": []
+        }
+      },
+      "tags": [],
+      "created_by": "custom",
+      "target_type": null,
+      "target_id": null
+    }
+  ],
+  "page_info": {
+    "current_count": 2,
+    "next_marker": null
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

Authentication failed or you do not have the operation permissions.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Compliance
+
+
+ diff --git a/docs/config/api-ref/rms_04_0505.html b/docs/config/api-ref/rms_04_0505.html new file mode 100644 index 00000000..03f4d822 --- /dev/null +++ b/docs/config/api-ref/rms_04_0505.html @@ -0,0 +1,830 @@ + + +

Modifying a Rule

+

Function

This API is used to modify a rule.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+

policy_assignment_id

+

Yes

+

String

+

Specifies the rule ID.

+

Maximum: 36

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

policy_assignment_type

+

Yes

+

String

+

Specifies the rule type. A rule type can be custom or builtin. If this parameter is not configured, builtin is used by default.

+

name

+

Yes

+

String

+

Specifies the rule name.

+

Maximum: 64

+

description

+

No

+

String

+

Specifies the rule description.

+

Maximum: 512

+

period

+

No

+

String

+

Specifies the trigger period.

+

You need to set this parameter when trigger type is set to periodic execution.

+

policy_filter

+

No

+

PolicyFilterDefinition object

+

Specifies the policy filter of a rule.

+

You need to set this parameter when trigger type is set to configuration change.

+

policy_definition_id

+

No

+

String

+

Specifies the policy definition ID.

+

To add a rule with a predefined policy, you need to set this parameter.

+

Maximum: 36

+

custom_policy

+

No

+

CustomPolicy object

+

Specifies the custom rule.

+

To create a custom rule, you need to set this parameter.

+

parameters

+

No

+

Map<String,PolicyParameterValue>

+

Specifies the rule parameters.

+

tags

+

No

+

Array of ResourceTag objects

+

Tags

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 PolicyFilterDefinition

Parameter

+

Mandatory

+

Type

+

Description

+

region_id

+

No

+

String

+

Specifies the region ID.

+

Maximum: 128

+

resource_provider

+

No

+

String

+

Specifies the cloud service name.

+

Maximum: 128

+

resource_type

+

No

+

String

+

Specifies the resource type.

+

Maximum: 128

+

resource_id

+

No

+

String

+

Specifies the resource ID.

+

Maximum: 512

+

tag_key

+

No

+

String

+

Specifies the tag key.

+

Maximum: 128

+

tag_value

+

No

+

String

+

Specifies the tag value.

+

Maximum: 256

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 5 CustomPolicy

Parameter

+

Mandatory

+

Type

+

Description

+

function_urn

+

Yes

+

String

+

Specifies the URN of a custom function.

+

Maximum: 1024

+

auth_type

+

Yes

+

String

+

Specifies how function is called by a custom rule.

+

auth_value

+

No

+

Map<String,Object>

+

Specifies the parameter value for invoking a function by a custom rule.

+
+
+ +
+ + + + + + + + + + + +
Table 6 PolicyParameterValue

Parameter

+

Mandatory

+

Type

+

Description

+

value

+

No

+

Object

+

Specifies the value of the rule parameter.

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 7 ResourceTag

Parameter

+

Mandatory

+

Type

+

Description

+

key

+

Yes

+

String

+

Tag key. A tag key can contain up to 128 Unicode characters and must complay with the character set specifications in section 3.1.

+

Minimum: 1

+

Maximum: 128

+

value

+

Yes

+

String

+

Tag value. A tag value can contain up to 255 Unicode characters and must comply with the character set specifications in section 3.2.

+

Minimum: 0

+

Maximum: 255

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

policy_assignment_type

+

String

+

Specifies the rule type, which can be builtin or custom.

+

id

+

String

+

Specifies the rule ID.

+

name

+

String

+

Specifies the rule name.

+

description

+

String

+

Specifies the rule description.

+

policy_filter

+

PolicyFilterDefinition object

+

Specifies the policy filter of a rule.

+

period

+

String

+

Specifies how often the rule is triggered, which can be One_Hour, Three_Hours, Six_Hours, Twelve_Hours, or TwentyFour_Hours.

+

state

+

String

+

Specifies the rule status.

+

created

+

String

+

Specifies the time when the rule was added.

+

updated

+

String

+

Specifies the time when the rule was modified.

+

policy_definition_id

+

String

+

Specifies the ID of the policy used by the rule.

+

custom_policy

+

CustomPolicy object

+

Specifies the custom rule.

+

parameters

+

Map<String,PolicyParameterValue>

+

Specifies the rule parameters.

+

tags

+

Array of ResourceTag objects

+

Tags

+

created_by

+

String

+

Specifies the person who created the rule.

+

target_type

+

String

+

traget_type is reserved for new features usage. In current version the result is null.

+

target_id

+

String

+

target_id is reserved for new features usage. In current version the result is null.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 9 PolicyFilterDefinition

Parameter

+

Type

+

Description

+

region_id

+

String

+

Specifies the region ID.

+

Maximum: 128

+

resource_provider

+

String

+

Specifies the cloud service name.

+

Maximum: 128

+

resource_type

+

String

+

Specifies the resource type.

+

Maximum: 128

+

resource_id

+

String

+

Specifies the resource ID.

+

Maximum: 512

+

tag_key

+

String

+

Specifies the tag key.

+

Maximum: 128

+

tag_value

+

String

+

Specifies the tag value.

+

Maximum: 256

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 10 CustomPolicy

Parameter

+

Type

+

Description

+

function_urn

+

String

+

Specifies the URN of a custom function.

+

Maximum: 1024

+

auth_type

+

String

+

Specifies how function is called by a custom rule.

+

auth_value

+

Map<String,Object>

+

Specifies the parameter value for invoking a function by a custom rule.

+
+
+ +
+ + + + + + + + + +
Table 11 PolicyParameterValue

Parameter

+

Type

+

Description

+

value

+

Object

+

Specifies the value of the rule parameter.

+
+
+ +
+ + + + + + + + + + + + + +
Table 12 ResourceTag

Parameter

+

Type

+

Description

+

key

+

String

+

Tag key. A tag key can contain up to 128 Unicode characters and must complay with the character set specifications in section 3.1.

+

Minimum: 1

+

Maximum: 128

+

value

+

String

+

Tag value. A tag value can contain up to 255 Unicode characters and must comply with the character set specifications in section 3.2.

+

Minimum: 0

+

Maximum: 255

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 13 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 14 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 15 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 16 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

PUT https://{endpoint}/v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}
+
+{
+    "policy_assignment_type": "builtin",
+    "domain_id": "daf2557fc0de4da09e128441baa71697",
+    "name": "allowed-ecs-flavorss3",
+    "description": "An ECS is noncompliant if its flavor is not in the specified flavor list TEST.",
+    "parameters": {
+        "listOfAllowedFlavors": {
+            "value": []
+        }
+    },
+    "policy_definition_id": "5f8d549bffeecc14f1fb522a",
+    "policy_filter": {
+        "region_id": null,
+        "resource_provider": "ecs",
+        "resource_type": "cloudservers",
+        "resource_id": null,
+        "tag_key": null,
+        "tag_value": null
+    }
+}
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "policy_assignment_type": "builtin",
+  "id": "6672d83777c56f4aeb50b892",
+  "name": "allowed-ecs-flavorss3",
+  "description": "An ECS is noncompliant if its flavor is not in the specified flavor list TEST.",
+  "policy_filter": {
+    "region_id": null,
+    "resource_provider": "ecs",
+    "resource_type": "cloudservers",
+    "resource_id": null,
+    "tag_key": null,
+    "tag_value": null
+  },
+  "period": null,
+  "state": "Enabled",
+  "created": "2024-06-19T13:08:07.771Z",
+  "updated": "2024-07-08T10:25:40.816Z",
+  "policy_definition_id": "5f8d549bffeecc14f1fb522a",
+  "custom_policy": null,
+  "parameters": {
+    "listOfAllowedFlavors": {
+      "value": []
+    }
+  },
+  "tags": [],
+  "created_by": "custom",
+  "target_type": null,
+  "target_id": null
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

Authentication failed or you do not have the operation permissions.

+

404

+

No rules found.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Compliance
+
+
+ diff --git a/docs/config/api-ref/rms_04_0506.html b/docs/config/api-ref/rms_04_0506.html new file mode 100644 index 00000000..0a7e1d7d --- /dev/null +++ b/docs/config/api-ref/rms_04_0506.html @@ -0,0 +1,551 @@ + + +

Querying a Rule

+

Function

This API is used to query a rule based on the rule ID.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+

policy_assignment_id

+

Yes

+

String

+

Specifies the rule ID.

+

Maximum: 36

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

policy_assignment_type

+

String

+

Specifies the rule type, which can be builtin or custom.

+

id

+

String

+

Specifies the rule ID.

+

name

+

String

+

Specifies the rule name.

+

description

+

String

+

Specifies the rule description.

+

policy_filter

+

PolicyFilterDefinition object

+

Specifies the policy filter of a rule.

+

period

+

String

+

Specifies how often the rule is triggered, which can be One_Hour, Three_Hours, Six_Hours, Twelve_Hours, or TwentyFour_Hours.

+

state

+

String

+

Specifies the rule status.

+

created

+

String

+

Specifies the time when the rule was added.

+

updated

+

String

+

Specifies the time when the rule was modified.

+

policy_definition_id

+

String

+

Specifies the ID of the policy used by the rule.

+

custom_policy

+

CustomPolicy object

+

Specifies the custom rule.

+

parameters

+

Map<String,PolicyParameterValue>

+

Specifies the rule parameters.

+

tags

+

Array of ResourceTag objects

+

Tags

+

created_by

+

String

+

Specifies the person who created the rule.

+

target_type

+

String

+

traget_type is reserved for new features usage. In current version the result is null.

+

target_id

+

String

+

target_id is reserved for new features usage. In current version the result is null.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 PolicyFilterDefinition

Parameter

+

Type

+

Description

+

region_id

+

String

+

Specifies the region ID.

+

Maximum: 128

+

resource_provider

+

String

+

Specifies the cloud service name.

+

Maximum: 128

+

resource_type

+

String

+

Specifies the resource type.

+

Maximum: 128

+

resource_id

+

String

+

Specifies the resource ID.

+

Maximum: 512

+

tag_key

+

String

+

Specifies the tag key.

+

Maximum: 128

+

tag_value

+

String

+

Specifies the tag value.

+

Maximum: 256

+
+
+ +
+ + + + + + + + + + + + + + + + + +
Table 5 CustomPolicy

Parameter

+

Type

+

Description

+

function_urn

+

String

+

Specifies the URN of a custom function.

+

Maximum: 1024

+

auth_type

+

String

+

Specifies how function is called by a custom rule.

+

auth_value

+

Map<String,Object>

+

Specifies the parameter value for invoking a function by a custom rule.

+
+
+ +
+ + + + + + + + + +
Table 6 Parameter description of the example policy

Parameter

+

Type

+

Description

+

listOfAllowedFlavors

+

Array

+

Indicates the list of allowed ECS flavors. The value must be an array with up to 10 elements. Example ECS flavors are as follows: s6.small.1, s6.xlarge.2, m7.large.8, and t6.small.1. To get more details, see ECS documentation.

+
+
+ +
+ + + + + + + + + +
Table 7 PolicyParameterValue

Parameter

+

Type

+

Description

+

value

+

Object

+

Specifies the value of the rule parameter.

+
+
+ +
+ + + + + + + + + + + + + +
Table 8 ResourceTag

Parameter

+

Type

+

Description

+

key

+

String

+

Tag key. A tag key can contain up to 128 Unicode characters and must complay with the character set specifications in section 3.1.

+

Minimum: 1

+

Maximum: 128

+

value

+

String

+

Tag value. A tag value can contain up to 255 Unicode characters and must comply with the character set specifications in section 3.2.

+

Minimum: 0

+

Maximum: 255

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 11 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 12 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "policy_assignment_type": "builtin",
+  "id": "6672d83777c56f4aeb50b892",
+  "name": "allowed-ecs-flavorss3",
+  "description": "An ECS is noncompliant if its flavor is not in the specified flavor list TEST.",
+  "policy_filter": {
+    "region_id": null,
+    "resource_provider": "ecs",
+    "resource_type": "cloudservers",
+    "resource_id": null,
+    "tag_key": null,
+    "tag_value": null
+  },
+  "period": null,
+  "state": "Enabled",
+  "created": "2024-06-19T13:08:07.771Z",
+  "updated": "2024-07-08T10:25:40.816Z",
+  "policy_definition_id": "5f8d549bffeecc14f1fb522a",
+  "custom_policy": null,
+  "parameters": {
+    "listOfAllowedFlavors": {
+      "value": []
+    }
+  },
+  "tags": [],
+  "created_by": "custom",
+  "target_type": null,
+  "target_id": null
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

Authentication failed or you do not have the operation permissions.

+

404

+

No rules found.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Compliance
+
+
+ diff --git a/docs/config/api-ref/rms_04_0507.html b/docs/config/api-ref/rms_04_0507.html new file mode 100644 index 00000000..3257cae4 --- /dev/null +++ b/docs/config/api-ref/rms_04_0507.html @@ -0,0 +1,234 @@ + + +

Deleting a Rule

+

Function

This API is used to delete a rule based on the rule ID. Only rules in the disabled state can be deleted.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+

policy_assignment_id

+

Yes

+

String

+

Specifies the rule ID.

+

Maximum: 36

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

None

+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

Authentication failed or you do not have the operation permissions.

+

404

+

No rules found.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Compliance
+
+
+ diff --git a/docs/config/api-ref/rms_04_0508.html b/docs/config/api-ref/rms_04_0508.html new file mode 100644 index 00000000..448bdd40 --- /dev/null +++ b/docs/config/api-ref/rms_04_0508.html @@ -0,0 +1,234 @@ + + +

Enabling a Rule

+

Function

This API is used to enable a rule based on the rule ID.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}/enable

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+

policy_assignment_id

+

Yes

+

String

+

Specifies the rule ID.

+

Maximum: 36

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

None

+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

202

+

Operation accepted.

+

400

+

Invalid parameters.

+

403

+

Authentication failed or you do not have the operation permissions.

+

404

+

Resources not found.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Compliance
+
+
+ diff --git a/docs/config/api-ref/rms_04_0509.html b/docs/config/api-ref/rms_04_0509.html new file mode 100644 index 00000000..fc1f9e9a --- /dev/null +++ b/docs/config/api-ref/rms_04_0509.html @@ -0,0 +1,234 @@ + + +

Disabling a Rule

+

Function

This API is used to disable a rule based on the rule ID.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}/disable

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+

policy_assignment_id

+

Yes

+

String

+

Specifies the rule ID.

+

Maximum: 36

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

None

+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

202

+

Operation accepted.

+

400

+

Invalid parameters.

+

403

+

Authentication failed or you do not have the operation permissions.

+

404

+

No rules found.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Compliance
+
+
+ diff --git a/docs/config/api-ref/rms_04_0510.html b/docs/config/api-ref/rms_04_0510.html new file mode 100644 index 00000000..925cd346 --- /dev/null +++ b/docs/config/api-ref/rms_04_0510.html @@ -0,0 +1,234 @@ + + +

Running a Resource Compliance Evaluation

+

Function

This API is used to trigger a rule manually by rule ID to evaluate resources.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}/policy-states/run-evaluation

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+

policy_assignment_id

+

Yes

+

String

+

Specifies the rule ID.

+

Maximum: 36

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

None

+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

202

+

Operation accepted.

+

400

+

Invalid parameters.

+

403

+

Authentication failed or you do not have the operation permissions.

+

404

+

No rules found.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Compliance
+
+
+ diff --git a/docs/config/api-ref/rms_04_0511.html b/docs/config/api-ref/rms_04_0511.html new file mode 100644 index 00000000..d5d2dcdd --- /dev/null +++ b/docs/config/api-ref/rms_04_0511.html @@ -0,0 +1,290 @@ + + +

Querying the Evaluation Status of a Rule

+

Function

This API is used to query the evaluation status of a rule by rule ID.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}/policy-states/evaluation-state

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+

policy_assignment_id

+

Yes

+

String

+

Specifies the rule ID.

+

Maximum: 36

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

policy_assignment_id

+

String

+

Specifies the rule ID.

+

state

+

String

+

Specifies the evaluation status.

+

start_time

+

String

+

Specifies the evaluation start time.

+

end_time

+

String

+

Specifies the evaluation end time.

+

error_message

+

String

+

Specifies the error message for the evaluation failure.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "state" : "Succeeded",
+  "policy_assignment_id" : "5fb6292765ee7f5e92a7ca4b",
+  "start_time" : "2020-11-19T08:13:27.441Z",
+  "end_time" : "2020-11-19T08:13:27.485Z",
+  "error_message" : null
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

Authentication failed or you do not have the operation permissions.

+

404

+

No rules found.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Compliance
+
+
+ diff --git a/docs/config/api-ref/rms_04_0512.html b/docs/config/api-ref/rms_04_0512.html new file mode 100644 index 00000000..a5c3e606 --- /dev/null +++ b/docs/config/api-ref/rms_04_0512.html @@ -0,0 +1,471 @@ + + +

Querying the Compliance Results of a Resource

+

Function

This API is used to query all compliance results of a resource evaluated by rules. The resource is searched by resource ID.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/resources/{resource_id}/policy-states

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+

resource_id

+

Yes

+

String

+

Specifies the resource ID.

+

Maximum: 512

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

compliance_state

+

No

+

String

+

Specifies the compliance status.

+

Maximum: 16

+

limit

+

No

+

Integer

+

Specifies the maximum number of records to return.

+

Minimum: 1

+

Maximum: 200

+

Default: 200

+

marker

+

No

+

String

+

Specifies the pagination parameter.

+

Minimum: 4

+

Maximum: 400

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

value

+

Array of PolicyState objects

+

Specifies the return value of querying the compliance result.

+

page_info

+

PageInfo object

+

Specifies the pagination object.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 PolicyState

Parameter

+

Type

+

Description

+

domain_id

+

String

+

Specifies the user ID.

+

region_id

+

String

+

Specifies the ID of the region the resource belongs to.

+

resource_id

+

String

+

Specifies the resource ID.

+

resource_name

+

String

+

Specifies the resource name.

+

resource_provider

+

String

+

Specifies the cloud service name.

+

resource_type

+

String

+

Specifies the resource type.

+

trigger_type

+

String

+

Specifies the trigger type. The value can be resource or period.

+

compliance_state

+

String

+

Specifies the compliance status.

+

policy_assignment_id

+

String

+

Specifies the rule ID.

+

policy_assignment_name

+

String

+

Specifies the rule name.

+

policy_definition_id

+

String

+

Specifies the policy ID.

+

evaluation_time

+

String

+

Specifies the evaluation time of compliance status.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 PageInfo

Parameter

+

Type

+

Description

+

current_count

+

Integer

+

Specifies the resource quantity on the current page.

+

Minimum: 0

+

Maximum: 200

+

next_marker

+

String

+

Specifies the marker value of the next page.

+

Minimum: 4

+

Maximum: 400

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "value": [
+    {
+      "domain_id": "daf2557fc0de4da09e128441baa71697",
+      "region_id": "eu-de",
+      "resource_id": "d418cc33-dd14-43f7-aa1e-a72ecab1a9b3",
+      "resource_name": "ecs-aziuzko",
+      "resource_provider": "ecs",
+      "resource_type": "cloudservers",
+      "trigger_type": "resource",
+      "compliance_state": "NonCompliant",
+      "policy_assignment_id": "6672d6b0354ba95beef328d1",
+      "policy_assignment_name": "allowed-ecs-flavors",
+      "policy_definition_id": "5f8d549bffeecc14f1fb522a",
+      "evaluation_time": "1720441778399"
+    },
+    {
+      "domain_id": "daf2557fc0de4da09e128441baa71697",
+      "region_id": "eu-de",
+      "resource_id": "d418cc33-dd14-43f7-aa1e-a72ecab1a9b3",
+      "resource_name": "ecs-aziuzko",
+      "resource_provider": "ecs",
+      "resource_type": "cloudservers",
+      "trigger_type": "resource",
+      "compliance_state": "NonCompliant",
+      "policy_assignment_id": "6672d83777c56f4aeb50b892",
+      "policy_assignment_name": "allowed-ecs-flavorss3",
+      "policy_definition_id": "5f8d549bffeecc14f1fb522a",
+      "evaluation_time": "1720441808621"
+    }
+  ],
+  "page_info": {
+    "current_count": 2,
+    "next_marker": null
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

Authentication failed or you do not have the operation permissions.

+

404

+

Resources not found.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Compliance
+
+
+ diff --git a/docs/config/api-ref/rms_04_0513.html b/docs/config/api-ref/rms_04_0513.html new file mode 100644 index 00000000..2dc92b57 --- /dev/null +++ b/docs/config/api-ref/rms_04_0513.html @@ -0,0 +1,475 @@ + + +

Querying All Compliance Results of Resources Evaluated by a Rule

+

Function

This API is used to query all compliance results of resources evaluated by a rule. The rule is searched by rule ID.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}/policy-states

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+

policy_assignment_id

+

Yes

+

String

+

Specifies the rule ID.

+

Maximum: 36

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

compliance_state

+

No

+

String

+

Specifies the compliance status.

+

Maximum: 16

+

resource_id

+

No

+

String

+

Specifies the resource ID.

+

Maximum: 512

+

resource_name

+

No

+

String

+

Specifies the resource name.

+

Maximum: 256

+

limit

+

No

+

Integer

+

Specifies the maximum number of records to return.

+

Minimum: 1

+

Maximum: 200

+

Default: 200

+

marker

+

No

+

String

+

Specifies the pagination parameter.

+

Minimum: 4

+

Maximum: 400

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

value

+

Array of PolicyState objects

+

Specifies the return value of querying the compliance result.

+

page_info

+

PageInfo object

+

Specifies the pagination object.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 PolicyState

Parameter

+

Type

+

Description

+

domain_id

+

String

+

Specifies the user ID.

+

region_id

+

String

+

Specifies the ID of the region the resource belongs to.

+

resource_id

+

String

+

Specifies the resource ID.

+

resource_name

+

String

+

Specifies the resource name.

+

resource_provider

+

String

+

Specifies the cloud service name.

+

resource_type

+

String

+

Specifies the resource type.

+

trigger_type

+

String

+

Specifies the trigger type. The value can be resource or period.

+

compliance_state

+

String

+

Specifies the compliance status.

+

policy_assignment_id

+

String

+

Specifies the rule ID.

+

policy_assignment_name

+

String

+

Specifies the rule name.

+

policy_definition_id

+

String

+

Specifies the policy ID.

+

evaluation_time

+

String

+

Specifies the evaluation time of compliance status.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 PageInfo

Parameter

+

Type

+

Description

+

current_count

+

Integer

+

Specifies the resource quantity on the current page.

+

Minimum: 0

+

Maximum: 200

+

next_marker

+

String

+

Specifies the marker value of the next page.

+

Minimum: 4

+

Maximum: 400

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "value" : [ {
+    "domain_id" : "059b5c937100d3e40ff0c00a7675a0a0",
+    "region_id" : "eu-de",
+    "resource_id" : "010d95bd-87cd-4f22-ac00-db7fba7d927e",
+    "resource_name" : "ecs-cc-image-test1",
+    "resource_provider" : "ecs",
+    "resource_type" : "cloudservers",
+    "trigger_type" : "resource",
+    "compliance_state" : "NonCompliant",
+    "policy_assignment_id" : "5fb618a726a24c53767fa049",
+    "policy_assignment_name" : "policy-assignment-test1",
+    "policy_definition_id" : "5fa265c0aa1e6afc05a0ff07",
+    "evaluation_time" : 1605776482523
+  } ],
+  "page_info" : {
+    "current_count" : 1,
+    "next_marker" : null
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

Authentication failed or you do not have the operation permissions.

+

404

+

No rules found.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Compliance
+
+
+ diff --git a/docs/config/api-ref/rms_04_0514.html b/docs/config/api-ref/rms_04_0514.html new file mode 100644 index 00000000..0c2366c8 --- /dev/null +++ b/docs/config/api-ref/rms_04_0514.html @@ -0,0 +1,465 @@ + + +

Querying All Compliance Results of Resources Under a User

+

Function

This API is used to query all compliance results of resources under a user.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/policy-states

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

compliance_state

+

No

+

String

+

Specifies the compliance status.

+

Maximum: 16

+

resource_id

+

No

+

String

+

Specifies the resource ID.

+

Maximum: 512

+

resource_name

+

No

+

String

+

Specifies the resource name.

+

Maximum: 256

+

limit

+

No

+

Integer

+

Specifies the maximum number of records to return.

+

Minimum: 1

+

Maximum: 200

+

Default: 200

+

marker

+

No

+

String

+

Specifies the pagination parameter.

+

Minimum: 4

+

Maximum: 400

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

value

+

Array of PolicyState objects

+

Specifies the return value of querying the compliance result.

+

page_info

+

PageInfo object

+

Specifies the pagination object.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 PolicyState

Parameter

+

Type

+

Description

+

domain_id

+

String

+

Specifies the user ID.

+

region_id

+

String

+

Specifies the ID of the region the resource belongs to.

+

resource_id

+

String

+

Specifies the resource ID.

+

resource_name

+

String

+

Specifies the resource name.

+

resource_provider

+

String

+

Specifies the cloud service name.

+

resource_type

+

String

+

Specifies the resource type.

+

trigger_type

+

String

+

Specifies the trigger type. The value can be resource or period.

+

compliance_state

+

String

+

Specifies the compliance status.

+

policy_assignment_id

+

String

+

Specifies the rule ID.

+

policy_assignment_name

+

String

+

Specifies the rule name.

+

policy_definition_id

+

String

+

Specifies the policy ID.

+

evaluation_time

+

String

+

Specifies the evaluation time of compliance status.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 PageInfo

Parameter

+

Type

+

Description

+

current_count

+

Integer

+

Specifies the resource quantity on the current page.

+

Minimum: 0

+

Maximum: 200

+

next_marker

+

String

+

Specifies the marker value of the next page.

+

Minimum: 4

+

Maximum: 400

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 10 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "value" : [ {
+    "domain_id" : "059b5c937100d3e40ff0c00a7675a0a0",
+    "region_id" : "eu-de",
+    "resource_id" : "010d95bd-87cd-4f22-ac00-db7fba7d927e",
+    "resource_name" : "ecs-cc-image-test1",
+    "resource_provider" : "ecs",
+    "resource_type" : "cloudservers",
+    "trigger_type" : "resource",
+    "compliance_state" : "NonCompliant",
+    "policy_assignment_id" : "5fb618a726a24c53767fa049",
+    "policy_assignment_name" : "policy-assignment-test1",
+    "policy_definition_id" : "5fa265c0aa1e6afc05a0ff07",
+    "evaluation_time" : 1605776482523
+  } ],
+  "page_info" : {
+    "current_count" : 1,
+    "next_marker" : null
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

Authentication failed or you do not have the operation permissions.

+

404

+

Resources not found.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Compliance
+
+
+ diff --git a/docs/config/api-ref/rms_04_0515.html b/docs/config/api-ref/rms_04_0515.html new file mode 100644 index 00000000..9d8e0a78 --- /dev/null +++ b/docs/config/api-ref/rms_04_0515.html @@ -0,0 +1,477 @@ + + +

Updating the Compliance Result

+

Function

This API is used to update the compliance result of a custom rule.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /v1/resource-manager/domains/{domain_id}/policy-states

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

policy_resource

+

Yes

+

PolicyResource object

+

Specifies the resource.

+

trigger_type

+

Yes

+

String

+

Specifies the trigger type. The value can be resource or period.

+

compliance_state

+

Yes

+

String

+

Specifies the compliance status.

+

policy_assignment_id

+

Yes

+

String

+

Specifies the policy rule id.

+

policy_assignment_name

+

No

+

String

+

Specifies the policy rule name.

+

evaluation_time

+

Yes

+

String

+

Specifies when a rule is used to evaluate the resource compliance.

+

evaluation_hash

+

Yes

+

String

+

Specifies the evaluation verification code.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 PolicyResource

Parameter

+

Mandatory

+

Type

+

Description

+

resource_id

+

No

+

String

+

Specifies the resource ID.

+

resource_name

+

No

+

String

+

Specifies the resource name.

+

resource_provider

+

No

+

String

+

Specifies the cloud service name.

+

resource_type

+

No

+

String

+

Specifies the resource type.

+

region_id

+

No

+

String

+

Specifies the region ID.

+

domain_id

+

No

+

String

+

Specifies the ID of the user to which the resource belongs.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

domain_id

+

String

+

Specifies the user ID.

+

region_id

+

String

+

Specifies the ID of the region the resource belongs to.

+

resource_id

+

String

+

Specifies the resource ID.

+

resource_name

+

String

+

Specifies the resource name.

+

resource_provider

+

String

+

Specifies the cloud service name.

+

resource_type

+

String

+

Specifies the resource type.

+

trigger_type

+

String

+

Specifies the trigger type. The value can be resource or period.

+

compliance_state

+

String

+

Specifies the compliance status.

+

policy_assignment_id

+

String

+

Specifies the rule ID.

+

policy_assignment_name

+

String

+

Specifies the rule name.

+

policy_definition_id

+

String

+

Specifies the policy ID.

+

evaluation_time

+

String

+

Specifies the evaluation time of compliance status.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

The reported compliance result by functionGraph is NonCompliant.

+
PUT https://{endpoint}/v1/resource-manager/domains/{domain_id}/policy-states
+
+{
+  "policy_resource" : {
+    "domain_id" : "d0123456789",
+    "region_id" : "global",
+    "resource_id" : "abc0123456789",
+    "resource_name" : "test_user",
+    "resource_provider" : "iam",
+    "resource_type" : "users"
+  },
+  "trigger_type" : "resource",
+  "compliance_state" : "NonCompliant",
+  "policy_assignment_id" : "abc0123456789abc",
+  "policy_assignment_name" : "custom_policy",
+  "evaluation_time" : 1667374060248,
+  "evaluation_hash" : "89342b8f338165651991afb8bd471396"
+}
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "domain_id" : "d0123456789",
+  "region_id" : "global",
+  "resource_id" : "abc0123456789",
+  "resource_name" : "test_user",
+  "resource_provider" : "iam",
+  "resource_type" : "users",
+  "trigger_type" : "resource",
+  "compliance_state" : "NonCompliant",
+  "policy_assignment_id" : "abc0123456789abc",
+  "policy_assignment_name" : "custom_policy",
+  "policy_definition_id" : null,
+  "evaluation_time" : 1667374060248
+}
+

Status code: 400

+

Operation failed.

+

The following error code and message do not indicate any exceptions if they are displayed when you invoke the API based on the example request.

+
{   
+  "error_code": "invalid_parameters",
+  "error_msg": "evaluationHash should not be customized"
+}
+

A FunctionGraph function of a Config rule requires a valid evaluation_hash for it to operate normally. After a custom Config rule is triggered, Config sends an event to call the corresponding FunctionGraph function. And the FunctionGraph function obtains the evaluation_hash from the event. After obtaining the evaluation_hash, the function sends evaluation results to Config using the API.

+

In general, this API is not intended for users, but for FunctionGraph functions of Config rules. If the preceding error message is displayed when you call this API, it indicates that the FunctionGraph function has the permission to send evaluation results to Config.

+
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

Authentication failed or you do not have the operation permissions.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Compliance
+
+
+ diff --git a/docs/config/api-ref/rms_04_0600.html b/docs/config/api-ref/rms_04_0600.html new file mode 100644 index 00000000..96cd3307 --- /dev/null +++ b/docs/config/api-ref/rms_04_0600.html @@ -0,0 +1,16 @@ + + +

Region Management

+

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/config/api-ref/rms_04_0601.html b/docs/config/api-ref/rms_04_0601.html new file mode 100644 index 00000000..a9b02d11 --- /dev/null +++ b/docs/config/api-ref/rms_04_0601.html @@ -0,0 +1,290 @@ + + +

Querying Regions Visible to You

+

Function

This API is used to query regions visible to you.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/regions

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Language

+

No

+

String

+

Language of the returned message.

+

Default: en-us

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

value

+

Array of Region objects

+

Specifies the list of region information.

+
+
+ +
+ + + + + + + + + + + + + +
Table 4 Region

Parameter

+

Type

+

Description

+

region_id

+

String

+

Specifies the region ID.

+

display_name

+

String

+

Specifies the display name.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "value" : [ {
+    "region_id" : "regionid1",
+    "display_name" : "region1"
+  }, {
+    "region_id" : "regionid2",
+    "display_name" : "region2"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

User authentication failed.

+

404

+

User not found.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Region Management
+
+
+ diff --git a/docs/config/api-ref/rms_04_0700.html b/docs/config/api-ref/rms_04_0700.html new file mode 100644 index 00000000..1ae390c7 --- /dev/null +++ b/docs/config/api-ref/rms_04_0700.html @@ -0,0 +1,28 @@ + + +

Advanced Queries

+

+
+
+ + +
+
Parent topic: APIs
+
+
+ diff --git a/docs/config/api-ref/rms_04_0701.html b/docs/config/api-ref/rms_04_0701.html new file mode 100644 index 00000000..18744a17 --- /dev/null +++ b/docs/config/api-ref/rms_04_0701.html @@ -0,0 +1,316 @@ + + +

Running Advanced Queries

+

Function

This API is used to run advanced queries.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1/resource-manager/domains/{domain_id}/run-query

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+ +
+ + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

expression

+

Yes

+

String

+

Specifies the ResourceQL expression.

+

Minimum: 1

+

Maximum: 4096

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

query_info

+

QueryInfo object

+

Specifies the ResourceQL query field.

+

results

+

Array of objects

+

Specifies the ResourceQL query result.

+
+
+ +
+ + + + + + + + + +
Table 5 QueryInfo

Parameter

+

Type

+

Description

+

select_fields

+

Array of strings

+

Specifies the ResourceQL query field.

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 429

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "query_info" : {
+    "select_fields" : [ "id" ]
+  },
+  "results" : [ {
+    "id" : "91252cc9-bfd9-0709-0912-56b397e0ba3f"
+  } ]
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

User authentication failed.

+

429

+

Limit exceeded.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Advanced Queries
+
+
+ diff --git a/docs/config/api-ref/rms_04_0702.html b/docs/config/api-ref/rms_04_0702.html new file mode 100644 index 00000000..d32a5402 --- /dev/null +++ b/docs/config/api-ref/rms_04_0702.html @@ -0,0 +1,329 @@ + + +

Creating an Advanced Query

+

Function

This API is used to create an advanced query.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

POST /v1/resource-manager/domains/{domain_id}/stored-queries

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Specifies the ResourceQL name.

+

Minimum: 1

+

Maximum: 64

+

description

+

No

+

String

+

Specifies the ResourceQL description.

+

Minimum: 0

+

Maximum: 512

+

expression

+

Yes

+

String

+

Specifies the ResourceQL expression.

+

Minimum: 1

+

Maximum: 4096

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

ResourceQL ID.

+

Maximum: 256

+

name

+

String

+

Specifies the ResourceQL name.

+

Minimum: 1

+

Maximum: 64

+

type

+

String

+

Indicates a customized query type. The options are account and aggregator. account: customized query statement for a single account; If the value is aggregator, it indicates the customized query statement of the aggregator. The default value is account.

+

description

+

String

+

Specifies the ResourceQL description.

+

Minimum: 0

+

Maximum: 512

+

expression

+

String

+

Specifies the ResourceQL expression.

+

Minimum: 1

+

Maximum: 4096

+

created

+

String

+

Specifies when ResourceQL was created.

+

Minimum: 1

+

Maximum: 64

+

updated

+

String

+

Specifies when ResourceQL was updated.

+

Minimum: 1

+

Maximum: 64

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

Creating an advanced query to query stopped ECSs

+
POST https://{endpoint}/v1/resource-manager/domains/{domain_id}/stored-queries
+
+{
+  "name" : "stopped-ecs",
+  "description" : "Querying stopped ECSs",
+  "expression" : "SELECT id, name FROM resources WHERE provider = 'ecs' AND type = 'cloudservers' AND properties.status = 'SHUTOFF'"
+}
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "id" : "62b9126566d400721efceffa",
+  "name" : "stopped-ecs",
+  "type": "account",
+  "description" : "Querying stopped ECSs",
+  "expression" : "SELECT id, name FROM resources WHERE provider = 'ecs' AND type = 'cloudservers' AND properties.status = 'SHUTOFF'",
+  "created" : "2022-06-27T02:13:57.107Z",
+  "updated" : "2022-06-27T02:13:57.107Z"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

User authentication failed.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Advanced Queries
+
+
+ diff --git a/docs/config/api-ref/rms_04_0703.html b/docs/config/api-ref/rms_04_0703.html new file mode 100644 index 00000000..ae2fb7b8 --- /dev/null +++ b/docs/config/api-ref/rms_04_0703.html @@ -0,0 +1,385 @@ + + +

Listing Advanced Queries

+

Function

This API is used to list all advanced queries.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/stored-queries

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

Specifies the maximum number of records to return.

+

Minimum: 1

+

Maximum: 200

+

Default: 200

+

marker

+

No

+

String

+

Specifies the pagination parameter.

+

Minimum: 4

+

Maximum: 400

+

name

+

No

+

String

+

Specifies the ResourceQL name.

+

Minimum: 1

+

Maximum: 64

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

value

+

Array of StoredQuery objects

+

Specifies the list of advanced queries.

+

page_info

+

PageInfo object

+

Specifies the pagination object.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 5 StoredQuery

Parameter

+

Type

+

Description

+

id

+

String

+

ResourceQL ID.

+

Maximum: 256

+

name

+

String

+

Specifies the ResourceQL name.

+

Minimum: 1

+

Maximum: 64

+

type

+

String

+

Indicates a customized query type. The options are account and aggregator. account: customized query statement for a single account; If the value is aggregator, it indicates the customized query statement of the aggregator. The default value is account.

+

description

+

String

+

Specifies the ResourceQL description.

+

Minimum: 0

+

Maximum: 512

+

expression

+

String

+

Specifies the ResourceQL expression.

+

Minimum: 1

+

Maximum: 4096

+

created

+

String

+

Specifies when ResourceQL was created.

+

Minimum: 1

+

Maximum: 64

+

updated

+

String

+

Specifies when ResourceQL was updated.

+

Minimum: 1

+

Maximum: 64

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 PageInfo

Parameter

+

Type

+

Description

+

current_count

+

Integer

+

Specifies the resource quantity on the current page.

+

Minimum: 0

+

Maximum: 200

+

next_marker

+

String

+

Specifies the marker value of the next page.

+

Minimum: 4

+

Maximum: 400

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "value" : [ {
+    "id" : "62b9126566d400721efceffa",
+    "name" : "stopped-ecs",
+    "type" : "account",
+    "description" : "Querying stopped ECSs",
+    "expression" : "SELECT id, name FROM resources WHERE provider = 'ecs' AND type = 'cloudservers' AND properties.status = 'SHUTOFF'",
+    "created" : "2022-06-27T02:13:57.107Z",
+    "updated" : "2022-06-27T02:13:57.107Z"
+  } ],
+  "page_info" : {
+    "current_count" : 1,
+    "next_marker" : null
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

User authentication failed.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Advanced Queries
+
+
+ diff --git a/docs/config/api-ref/rms_04_0704.html b/docs/config/api-ref/rms_04_0704.html new file mode 100644 index 00000000..bc43e7e4 --- /dev/null +++ b/docs/config/api-ref/rms_04_0704.html @@ -0,0 +1,317 @@ + + +

Querying an Advanced Query

+

Function

This API is used to query an advanced query.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/stored-queries/{query_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+

query_id

+

Yes

+

String

+

Specifies the query ID.

+

Maximum: 36

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

ResourceQL ID.

+

Maximum: 256

+

name

+

String

+

Specifies the ResourceQL name.

+

Minimum: 1

+

Maximum: 64

+

type

+

String

+

Indicates a customized query type. The options are account and aggregator. account: customized query statement for a single account; If the value is aggregator, it indicates the customized query statement of the aggregator. The default value is account.

+

description

+

String

+

Specifies the ResourceQL description.

+

Minimum: 0

+

Maximum: 512

+

expression

+

String

+

Specifies the ResourceQL expression.

+

Minimum: 1

+

Maximum: 4096

+

created

+

String

+

Specifies when ResourceQL was created.

+

Minimum: 1

+

Maximum: 64

+

updated

+

String

+

Specifies when ResourceQL was updated.

+

Minimum: 1

+

Maximum: 64

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "id" : "62b9126566d400721efceffa",
+  "name" : "stopped-ecs",
+  "type": "account",
+  "description" : "Querying stopped ECSs",
+  "expression" : "SELECT id, name FROM resources WHERE provider = 'ecs' AND type = 'cloudservers' AND properties.status = 'SHUTOFF'",
+  "created" : "2022-06-27T02:13:57.107Z",
+  "updated" : "2022-06-27T02:13:57.107Z"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

User authentication failed.

+

404

+

No resource found.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Advanced Queries
+
+
+ diff --git a/docs/config/api-ref/rms_04_0705.html b/docs/config/api-ref/rms_04_0705.html new file mode 100644 index 00000000..0bcec962 --- /dev/null +++ b/docs/config/api-ref/rms_04_0705.html @@ -0,0 +1,371 @@ + + +

Updating an Advanced Query

+

Function

This API is used to update a custom query.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

PUT /v1/resource-manager/domains/{domain_id}/stored-queries/{query_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+

query_id

+

Yes

+

String

+

Specifies the query ID.

+

Maximum: 36

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + +
Table 3 Request body parameters

Parameter

+

Mandatory

+

Type

+

Description

+

name

+

Yes

+

String

+

Specifies the ResourceQL name.

+

Minimum: 1

+

Maximum: 64

+

description

+

No

+

String

+

Specifies the ResourceQL description.

+

Minimum: 0

+

Maximum: 512

+

expression

+

Yes

+

String

+

Specifies the ResourceQL expression.

+

Minimum: 1

+

Maximum: 4096

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

id

+

String

+

ResourceQL ID.

+

Maximum: 256

+

name

+

String

+

Specifies the ResourceQL name.

+

Minimum: 1

+

Maximum: 64

+

type

+

String

+

Indicates a customized query type. The options are account and aggregator. account: customized query statement for a single account; If the value is aggregator, it indicates the customized query statement of the aggregator. The default value is account.

+

description

+

String

+

Specifies the ResourceQL description.

+

Minimum: 0

+

Maximum: 512

+

expression

+

String

+

Specifies the ResourceQL expression.

+

Minimum: 1

+

Maximum: 4096

+

created

+

String

+

Specifies when ResourceQL was created.

+

Minimum: 1

+

Maximum: 64

+

updated

+

String

+

Specifies when ResourceQL was updated.

+

Minimum: 1

+

Maximum: 64

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

Updating the advanced query to query running ECSs

+
PUT https://{endpoint}/v1/resource-manager/domains/{domain_id}/stored-queries/{query_id}
+
+{
+  "name" : "running-ecs",
+  "description" : "Querying running ECSs",
+  "expression" : "SELECT id, name FROM resources WHERE provider = 'ecs' AND type = 'cloudservers' AND properties.status = 'ACTIVE'"
+}
+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "id" : "62b9126566d400721efceffa",
+  "name" : "running-ecs",
+  "type" : "account",
+  "description" : "Querying running ECSs",
+  "expression" : "SELECT id, name FROM resources WHERE provider = 'ecs' AND type = 'cloudservers' AND properties.status = 'ACTIVE'",
+  "created" : "2022-06-27T02:13:57.107Z",
+  "updated" : "2022-07-09T09:12:00.007Z"
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

User authentication failed.

+

404

+

No resource found.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Advanced Queries
+
+
+ diff --git a/docs/config/api-ref/rms_04_0706.html b/docs/config/api-ref/rms_04_0706.html new file mode 100644 index 00000000..ef409e1b --- /dev/null +++ b/docs/config/api-ref/rms_04_0706.html @@ -0,0 +1,234 @@ + + +

Deleting an Advanced Query

+

Function

This API is used to delete an advanced query.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

DELETE /v1/resource-manager/domains/{domain_id}/stored-queries/{query_id}

+ +
+ + + + + + + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+

query_id

+

Yes

+

String

+

Specifies the query ID.

+

Maximum: 36

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 2 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 3 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 404

+ +
+ + + + + + + + + + + + + +
Table 5 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 6 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

None

+
+

Example Responses

None

+
+

Status Codes

+
+ + + + + + + + + + + + + + + + + + + +

Status Code

+

Description

+

204

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

User authentication failed.

+

404

+

No resource found.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Advanced Queries
+
+
+ diff --git a/docs/config/api-ref/rms_04_0707.html b/docs/config/api-ref/rms_04_0707.html new file mode 100644 index 00000000..a2af23df --- /dev/null +++ b/docs/config/api-ref/rms_04_0707.html @@ -0,0 +1,339 @@ + + +

Querying Schemas

+

Function

This API is used to query schemas used by advanced queries.

+
+

Calling Method

For details, see Calling APIs.

+
+

URI

GET /v1/resource-manager/domains/{domain_id}/schemas

+ +
+ + + + + + + + + + + +
Table 1 Path Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

domain_id

+

Yes

+

String

+

Specifies tags.

+

Maximum: 36

+
+
+ +
+ + + + + + + + + + + + + + + + +
Table 2 Query Parameters

Parameter

+

Mandatory

+

Type

+

Description

+

limit

+

No

+

Integer

+

Specifies the maximum number of records to return.

+

Minimum: 1

+

Maximum: 200

+

Default: 200

+

marker

+

No

+

String

+

Specifies the pagination parameter.

+

Minimum: 4

+

Maximum: 400

+
+
+
+

Request Parameters

+
+ + + + + + + + + + + + + + + + +
Table 3 Request header parameters

Parameter

+

Mandatory

+

Type

+

Description

+

X-Auth-Token

+

No

+

String

+

Specifies the invoker's token.

+

X-Security-Token

+

No

+

String

+

Security token (session token) for temporary security credentials. This parameter is mandatory when you make an API call using temporary security credentials.

+
+
+
+

Response Parameters

Status code: 200

+ +
+ + + + + + + + + + + + + +
Table 4 Response body parameters

Parameter

+

Type

+

Description

+

value

+

Array of ResourceSchemaResponse objects

+

schemas object.

+

page_info

+

PageInfo object

+

Specifies the pagination object.

+
+
+ +
+ + + + + + + + + + + + + +
Table 5 ResourceSchemaResponse

Parameter

+

Type

+

Description

+

type

+

String

+

Specifies the resource type.

+

schema

+

Object

+

Specifies the schema content.

+
+
+ +
+ + + + + + + + + + + + + +
Table 6 PageInfo

Parameter

+

Type

+

Description

+

current_count

+

Integer

+

Specifies the resource quantity on the current page.

+

Minimum: 0

+

Maximum: 200

+

next_marker

+

String

+

Specifies the marker value of the next page.

+

Minimum: 4

+

Maximum: 400

+
+
+

Status code: 400

+ +
+ + + + + + + + + + + + + +
Table 7 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 403

+ +
+ + + + + + + + + + + + + +
Table 8 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+

Status code: 500

+ +
+ + + + + + + + + + + + + +
Table 9 Response body parameters

Parameter

+

Type

+

Description

+

error_code

+

String

+

Specifies the error code.

+

error_msg

+

String

+

Specifies the error message.

+
+
+
+

Example Requests

None

+
+

Example Responses

Status code: 200

+

Operation succeeded.

+
{
+  "value": [
+    {
+      "type": "aad.instances",
+      "schema": {
+        "vips": {
+          "__array": {
+            "ipId": "string",
+            "ip": "string"
+          }
+        },
+        "expireTime": "int",
+        "ispSpec": "string",
+        "specType": "int",
+        "basicBandwidth": "int",
+        "elasticBandwidth": "int",
+        "serviceBandwidth": "int",
+        "isAutoRenew": "int"
+      }
+    }
+  ],
+  "page_info": {
+    "current_count": 1,
+    "next_marker": "MDAwMDY2ODM5NjUy"
+  }
+}
+
+

Status Codes

+
+ + + + + + + + + + + + + + + + +

Status Code

+

Description

+

200

+

Operation succeeded.

+

400

+

Invalid parameters.

+

403

+

User authentication failed.

+

500

+

Server error.

+
+
+
+

Error Codes

See Error Codes.

+
+
+
+
+
Parent topic: Advanced Queries
+
+
+ diff --git a/docs/config/api-ref/rms_05_0000.html b/docs/config/api-ref/rms_05_0000.html new file mode 100644 index 00000000..80775b66 --- /dev/null +++ b/docs/config/api-ref/rms_05_0000.html @@ -0,0 +1,25 @@ + + +

Permissions Policies and Supported Actions

+
+
+ +
+ diff --git a/docs/config/api-ref/rms_05_0100.html b/docs/config/api-ref/rms_05_0100.html new file mode 100644 index 00000000..8c38cb4b --- /dev/null +++ b/docs/config/api-ref/rms_05_0100.html @@ -0,0 +1,30 @@ + + +

Permissions Policies and Supported Actions

+

This chapter describes how to use IAM to implement fine-grained permissions control for your Config resources. If your account does not need individual IAM users, skip this chapter.

+

A policy is a set of permissions defined in JSON format. By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.

+

Based on authorization granularity, permissions are classified into roles and policies.

+ +

Policy-based authorization is useful if you want to allow or deny the access to an API.

+
+

An account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. The permissions required for calling an API are determined by the actions supported by the API. Only users who have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user wants to query a resource recorder using an API, the user must have the permissions that allow the rms:trackerConfig:get action.

+

Supported Actions

Operations supported by policies are specific to APIs. The following are common concepts related to policies:

+ +
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/config/api-ref/rms_05_0200.html b/docs/config/api-ref/rms_05_0200.html new file mode 100644 index 00000000..744a8093 --- /dev/null +++ b/docs/config/api-ref/rms_05_0200.html @@ -0,0 +1,169 @@ + + +

Resource Query

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Permission

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Querying resources of a specific type

+

GET /v1/resource-manager/domains/{domain_id}/provider/{provider}/type/{type}/resources

+

rms:resources:list

+

√

+

x

+

Querying a resource

+

GET /v1/resource-manager/domains/{domain_id}/provider/{provider}/type/{type}/resources/{resource_id}

+

rms:resources:get

+

√

+

x

+

Listing resources recorded by the resource recorder

+

GET /v1/resource-manager/domains/{domain_id}/tracked-resources

+

rms:resources:list

+

√

+

x

+

Querying how many resources are recorded by the resource recorder

+

GET /v1/resource-manager/domains/{domain_id}/tracked-resources/count

+

rms:resources:list

+

√

+

x

+

Querying resource tags recorded by the resource recorder

+

GET /v1/resource-manager/domains/{domain_id}/tracked-resources/tags

+

rms:resources:list

+

√

+

x

+

Querying resource overview recorded by the resource recorder

+

GET /v1/resource-manager/domains/{domain_id}/tracked-resources/summary

+

rms:resources:list

+

√

+

x

+

Querying a specific resource recorded by the resource recorder

+

GET /v1/resource-manager/domains/{domain_id}/tracked-resources/{resource_id}

+

rms:resources:get

+

√

+

x

+

Querying a resource summary

+

GET /v1/resource-manager/domains/{domain_id}/all-resources/summary

+

rms:resources:list

+

√

+

x

+

Querying the number of resources

+

GET /v1/resource-manager/domains/{domain_id}/all-resources/count

+

rms:resources:list

+

√

+

x

+

Querying all resources under your account

+

GET /v1/resource-manager/domains/{domain_id}/all-resources

+

rms:resources:list

+

√

+

x

+

Listing cloud services

+

GET /v1/resource-manager/domains/{domain_id}/providers

+

Not required

+

x

+

x

+

Querying resource tags

+

GET /v1/resource-manager/domains/{domain_id}/all-resources/tags

+

rms:resources:list

+

√

+

x

+

Querying a resource under your account

+

GET /v1/resource-manager/domains/{domain_id}/all-resources/{resource_id}

+

rms:resources:get

+

√

+

x

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/config/api-ref/rms_05_0300.html b/docs/config/api-ref/rms_05_0300.html new file mode 100644 index 00000000..e61b9147 --- /dev/null +++ b/docs/config/api-ref/rms_05_0300.html @@ -0,0 +1,59 @@ + + +

Resource Recorder

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + +

Permission

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Querying the resource recorder

+

GET /v1/resource-manager/domains/{domain_id}/tracker-config

+

rms:trackerConfig:get

+

√

+

x

+

Creating or modifying the resource recorder

+

PUT /v1/resource-manager/domains/{domain_id}/tracker-config

+

rms:trackerConfig:put

+

√

+

x

+

Deleting the resource recorder

+

DELETE /v1/resource-manager/domains/{domain_id}/tracker-config

+

rms:trackerConfig:delete

+

√

+

x

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/config/api-ref/rms_05_0400.html b/docs/config/api-ref/rms_05_0400.html new file mode 100644 index 00000000..00f1a66c --- /dev/null +++ b/docs/config/api-ref/rms_05_0400.html @@ -0,0 +1,223 @@ + + +

Compliance

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Permission

+

API

+

Action

+

Dependencies

+

IAM Project

+

Enterprise Project

+

Querying all built-in policies

+

GET /v1/resource-manager/policy-definitions

+

rms:policyDefinitions:get

+

-

+

√

+

x

+

Querying a built-in policy

+

GET /v1/resource-manager/policy-definitions/{policy_definition_id}

+

rms:policyDefinitions:get

+

-

+

√

+

x

+

Modifying a rule

+

PUT /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}

+

rms:policyAssignments:update

+

-

+

√

+

x

+

Enabling a rule

+

POST /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}/enable

+

rms:policyAssignments:update

+

-

+

√

+

x

+

Disabling a rule

+

POST /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}/disable

+

rms:policyAssignments:update

+

-

+

√

+

x

+

Adding a rule

+

PUT /v1/resource-manager/domains/{domain_id}/policy-assignments

+

rms:policyAssignments:create

+

-

+

√

+

x

+

Querying all rules

+

GET /v1/resource-manager/domains/{domain_id}/policy-assignments

+

rms:policyAssignments:get

+

-

+

√

+

x

+

Querying a rule

+

GET /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}

+

rms:policyAssignments:get

+

-

+

√

+

x

+

Deleting a rule

+

DELETE /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}

+

rms:policyAssignments:delete

+

-

+

√

+

x

+

Querying the evaluation status of a rule

+

GET /v1/resource-manager/domains/{domain_id}/policy-states/evaluation-state

+

rms:policyStates:get

+

-

+

√

+

x

+

Querying the compliance results of a resource

+

GET /v1/resource-manager/domains/{domain_id}/resources/{resource_id}/policy-states

+

rms:policyStates:get

+

-

+

√

+

x

+

Querying all compliance results of resources under a user

+

GET /v1/resource-manager/domains/{domain_id}/policy-states

+

rms:policyStates:get

+

-

+

√

+

x

+

Querying all compliance results of resources evaluated by a rule

+

GET /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}/policy-states

+

rms:policyStates:get

+

-

+

√

+

x

+

Running a resource compliance evaluation

+

POST /v1/resource-manager/domains/{domain_id}/policy-assignments/{policy_assignment_id}/policy-states/run-evaluation

+

rms:policyStates:runEvaluation

+

-

+

√

+

x

+

Updating evaluation results

+

PUT /v1/resource-manager/domains/{domain_id}/policy-states

+

rms:policyStates:update

+

-

+

√

+

x

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/config/api-ref/rms_05_0500.html b/docs/config/api-ref/rms_05_0500.html new file mode 100644 index 00000000..45205091 --- /dev/null +++ b/docs/config/api-ref/rms_05_0500.html @@ -0,0 +1,103 @@ + + +

Advanced Queries

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Permissions

+

API

+

Action

+

IAM Project

+

Enterprise Project

+

Running advanced queries

+

POST /v1/resource-manager/domains/{domain_id}/run-query

+

rms:resources:runQuery

+

√

+

x

+

Creating an advanced query

+

POST /v1/resource-manager/domains/{domain_id}/stored-queries

+

rms:storedQueries:create

+

√

+

x

+

Querying an advanced query

+

GET /v1/resource-manager/domains/{domain_id}/stored-queries/{query_id}

+

rms:storedQueries:get

+

√

+

x

+

Listing advanced queries

+

GET /v1/resource-manager/domains/{domain_id}/stored-queries

+

rms:storedQueries:list

+

√

+

x

+

Updating an advanced query

+

PUT /v1/resource-manager/domains/{domain_id}/stored-queries/{query_id}

+

rms:storedQueries:update

+

√

+

x

+

Deleting an advanced query

+

DELETE /v1/resource-manager/domains/{domain_id}/stored-queries/{query_id}

+

rms:storedQueries:delete

+

√

+

x

+

Querying schemas

+

GET /v1/resource-manager/domains/{domain_id}/schemas

+

rms:schemas:list

+

√

+

x

+
+
+
+
+
+
Parent topic: Permissions Policies and Supported Actions
+
+
+ diff --git a/docs/config/api-ref/rms_06_0000.html b/docs/config/api-ref/rms_06_0000.html new file mode 100644 index 00000000..439e6ef9 --- /dev/null +++ b/docs/config/api-ref/rms_06_0000.html @@ -0,0 +1,17 @@ + + +

Appendixes

+
+
+ +
+ diff --git a/docs/config/api-ref/rms_06_0100.html b/docs/config/api-ref/rms_06_0100.html new file mode 100644 index 00000000..6a0e0bde --- /dev/null +++ b/docs/config/api-ref/rms_06_0100.html @@ -0,0 +1,14 @@ + + +

Supported Services and Resource Types

+

You can obtain the cloud services (provider) and resource types (type) supported by Config in either of the following ways:

+ +
+
+
+
Parent topic: Appendixes
+
+
+ diff --git a/docs/config/api-ref/rms_07_0200.html b/docs/config/api-ref/rms_07_0200.html new file mode 100644 index 00000000..79f0c978 --- /dev/null +++ b/docs/config/api-ref/rms_07_0200.html @@ -0,0 +1,121 @@ + + +

Status Codes

+
+
+
+
+
Parent topic: Appendixes
+
+
+ diff --git a/docs/config/api-ref/rms_08_0000.html b/docs/config/api-ref/rms_08_0000.html new file mode 100644 index 00000000..19b064e3 --- /dev/null +++ b/docs/config/api-ref/rms_08_0000.html @@ -0,0 +1,20 @@ + + +

Change History

+
+
+ + + + + + + +

Released On

+

Description

+

2024-07-30

+

This issue is the first official release.

+
+
+
+